Initialize standalone build #218
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Sayam753
approved these changes
Sep 1, 2021
CONTRIBUTING.md
Outdated
|
|
||
| To generate the draft standalone notebook gallery, you need to have installed all the packages in | ||
| `requirements-docs.txt` and to run `sphinx-build examples/ _build -b html` from the repository | ||
| home directory. |
There was a problem hiding this comment.
Maybe add -
To preview the generated docs locally, simply open _build/index.html file.
|
Thanks @OriolAbril 💯 |
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.
Description
This adds sphinx and readthedocs configuration files to generate a example gallery standalone
website and to get previews of such website in all open PRs.
It also configures bibtex references via sphinx with local bibliographies, tags and categories
via ablog and lays the groundwork for several more features.