Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include examples and documentation in the pre-compiled wheels for the package #97

Closed
paroomk opened this issue Jul 4, 2024 · 2 comments
Assignees

Comments

@paroomk
Copy link

paroomk commented Jul 4, 2024

I think the examples and documentation should be included in the pre-compiled wheels. This would make the package a lot more usable.

I had to clone the repo and follow the instructions under `Development Installation Instructions' to get access to the examples and documentation. Please let me know when you have fixed this.

cf: openjournals/joss-reviews/issues/6838

@alizma
Copy link
Member

alizma commented Jul 12, 2024

Hi @paroomk, thank you for the suggestion. I updated the build system to include all of our examples and documentation in plain text. So, future users will have a plaintext version of examples they can run as well as the text of our documentation. Please see our new release 1.0.2, which is now on PyPi. The wheel files can be seen here.

I don't think the fully built documentation should be included in the wheels, as this would overwhelm the size of our code and make the installation size relatively large, which doesn't seem like a nice thing as a default, especially when our documentation page is always live.

Please confirm the changes so I can close the issue. Thanks again!

@paroomk
Copy link
Author

paroomk commented Jul 13, 2024

Looks good, thank you for making the changes.

@alizma alizma closed this as completed Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants