🔧 Configure readthedocs documentation build #13
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Turns out groups and extras can't be used together in pyproject.toml by poetry, see python-poetry/poetry#4897. Changed things around so that `pip install .[docs]` works!
Getting our documentation on Readthedocs! Following https://jupyterbook.org/en/stable/publish/readthedocs.html
Just use readthedocs. Sadly this means we can't skip docs build for files outside the docs/ folder anymore.
Sneaking in some extra notes on how people can clone the repo, setup a virtual environment, install dependencies and build the jupyter book docs!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Getting our documentation built on Readthedocs following https://jupyterbook.org/en/stable/publish/readthedocs.html. Also documenting how to build the docs locally.
Preview at https://zen3geo--13.org.readthedocs.build/en/13/ or https://zen3geo.readthedocs.io
Supersedes #3.
Notes: