improving the readthedocs template #137
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
within the current template, 'basicstrap', the navigation on the left sidebar (with the partial TOC) is a bit counter-intuitive. The new template provides a more intituitive sidebars.
Add a line at end of section with link to download the notebook
Bachibouzouk
approved these changes
May 2, 2024
There was a problem hiding this comment.
Thanks for finding a nice theme and implementing it @mohammadamint !
I approved the PR but let us wait the approval of the JOSS reviewer before merging this into joss-review
I modified the notebook_converts.py script such that the notebooks are automatically converted to .rst upon build of the docs and that a link to download the .ipynb file is available directly into the RTD
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.
Within the current template, 'basicstrap', the navigation on the left sidebar (with the partial TOC) is a bit counter-intuitive. The new template provides a more intuitive sidebars.
To test, make sure new theme is installed through installing docs-requirements.txt in the docs directory:
pip install -r docs-requirements.txt