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

Leave example notebooks unexecuted in the repo #240

Open
brynpickering opened this issue Aug 23, 2023 · 0 comments
Open

Leave example notebooks unexecuted in the repo #240

brynpickering opened this issue Aug 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@brynpickering
Copy link
Contributor

What can be improved?

The example notebooks and their associated data take up most of the repo's footprint on disk. If they are stored without execution then they take up ~14MB instead of ~22MB.

The execution of the notebooks also clutters up commits, with logged execution time metadata counted as line changes and binary format images creating blocks of random characters.

There's no real reason to have the notebooks executed in the repo. We can test them without their executed state being stored. We can then have them executed when building the documentation, so they appear in their executed state in the docs. In fact, they could then be stored inside the docs directory so they are a bit hidden from the user, meaning they reach them almost solely from the docs.

The only disadvantage that I see is the time it takes to build the documentation: ~90 seconds instead of ~15 seconds.

Version

0.2.5-dev

@brynpickering brynpickering added enhancement New feature or request documentation Improvements or additions to documentation labels Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant