-
Notifications
You must be signed in to change notification settings - Fork 529
Auto notebooks from examples with shpinx-gallery #27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This file contains hidden or 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
@rflamary you should not put the rendered notebook in the main source tree. It will make its size explode. one option would be to build the doc eg with circleci like sklearn does it and it gets pushed to the website repo that is hosted on github pages. |
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 handle automatic conversion from examples to notebooks with sphinx-gallery (cf issue #16 ). It does not change the code of the features but aim at making this conversion smooth while keeping the readthedoc documentation running.
Main changes:
This was a very bumpy road for several reasons:
It is still difficult to have a doc that build smoothly in local and readthedoc. The only solution I found is to build the doc locally with sphinx-gallery enabled, which creates the *rst and so on and remove the sphinx-gallery extension for readthedoc compatibility. We cannot build the whole doc on readthedoc since POT require compilation which is forbidden. The local build is performed but the script
nb_build
in the docs folder (it temporarily removes the mock modules necessary for building the docs without compilation).Sphinx-gallery does not do a proper rst to md conversion fro the notebooks (see their issue 219). Which means that in order to have proper sub-title we need to put in the code something like
Because this code is the only one that allows for both titles in rst and mardown and renders well in the notebooks and documentation.