You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: