-
Notifications
You must be signed in to change notification settings - Fork 46
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
Docs/add nb for download #66
Merged
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
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.
PR
This PR creates copies of the tutorial notebooks and places them in a folder called notebooks. Please note the following:
transform_notebook.py
where it is for now, in case we need all the options used previously. If it is decided that we no longer want the flexibility here and all we need is < 20-30 lines this could be consolidated into themake.py
.sphinx/auxiliary
– ideally, we would want to drop the getting started notebook in there, but two items need to be sorted out first:a. I don’t think we want to drop the notebook template in to
notebooks
as it is more of a developer thingb. Creating a link in the readme for downloading the getting started notebook will work there but not in the Sphinx documentation which just pulls in the
readme.rst
.Insertion of links for notebook download in
examples.rst
will be added in a subsequent PR.Run
To run please navigate to the sphinx folder and use
python make.py html
. Ensure that your copies of the notebooks innotebooks
have been refreshed as part of the documentation build and that they do not contain the two cells for setting locations for facet, sklearndf and pytools or the matplotlib config cell as these are excluded based on cell metadata process by thetransform_notebook.py
. All other documentation should look the same.