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

Document building needs a rethink. #97

Open
NathanCummings opened this issue Nov 27, 2024 · 1 comment
Open

Document building needs a rethink. #97

NathanCummings opened this issue Nov 27, 2024 · 1 comment
Assignees

Comments

@NathanCummings
Copy link
Member

NathanCummings commented Nov 27, 2024

Currently, Jupyter book will run all of the cells when you try to build the docs. This means that, for example, the cell that shows getting and installing s5cmd, will actually run those commands, downloading the s5cmd source and try to run it to download data.

@NathanCummings
Copy link
Member Author

We are also thinking that we shouldn't be building the docs and tracking the build artefacts with git, rather we should be dynamically building the docs in CI and just tracking the Jupyter notebooks. This would reduce the size of the repo significantly and make it quicker to clone.

This may have implications in that we'd possibly need to build the docs locally if doing development work that doesn't involve the docs, which is not entirely ideal. To be investigated.

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

4 participants