📝 Initialize readthedocs documentation page #3
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
Create beautiful, publication-quality books and documents from computational content! Need to set upper pin on Python version because sphinx-external-toc requires Python ~=3.7, so it will not be satisfied for Python >=4.0
Use `jupyter-book create docs/`and follow https://jupyterbook.org/en/stable/advanced/developers.html#api-reference-from-docstrings to get API docs automatically generated.
Getting the documentation on Readthedocs! Following https://jupyterbook.org/en/stable/publish/readthedocs.html
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 the Jupyter Book documentation built on Readthedocs following https://jupyterbook.org/en/stable/start/create.html and https://jupyterbook.org/en/stable/publish/readthedocs.html.
Preview at https://bambooflow--3.org.readthedocs.build/en/3/
Adapted from weiji14/zen3geo#3 and weiji14/zen3geo#13
Notes:
.readthedocs.yamlfile in custom location underdocs/following https://docs.readthedocs.io/en/stable/guides/setup/monorepo.html#how-to-use-a-readthedocs-yaml-file-in-a-sub-folder