Change documentation theme #101
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
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
trallard
approved these changes
Nov 19, 2024
There was a problem hiding this comment.
I did see that warning about file name too long when running with sphinx-build -b docs/ docs/_build/html but
Running with:
sphinx-build -b html docs docs/build/html -j auto
#or
sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto
did not result in that warning and the built docs look all good so it seemed there was some odd recursive creation of the html files happening
jakevdp
reviewed
Nov 19, 2024
pavithraes
commented
Nov 19, 2024
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.
This PR introduces
sphinx_book_theme, similar to the JAX documentation. Also addssphinx-copybuttonextension.Preview link: https://jax-ai-stack--101.org.readthedocs.build/en/101/
Note for reviewers: Please also try a local docs build. I was running into intermittent sphinx warnings ("file too long" and "...ipynb :document isn't included in any toctree"). I'm fairly certain those were local env/cache issues, but will be good to verify.