Skip to content
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 21 commits into from
Sep 22, 2020
Merged

Docs/add nb for download #66

merged 21 commits into from
Sep 22, 2020

Conversation

jason-bentley
Copy link
Contributor

PR

This PR creates copies of the tutorial notebooks and places them in a folder called notebooks. Please note the following:

  1. Decided to leave 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 the make.py.
  2. The downloaded notebooks are not populated with cell output. This is because we only commit without cell output.
  3. For now, I have also omitted the two notebooks in 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 thing
    b. 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 in notebooks 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 the transform_notebook.py. All other documentation should look the same.

@jason-bentley jason-bentley merged commit 6bf0e59 into develop Sep 22, 2020
@j-ittner j-ittner deleted the docs/add_nb_for_download branch September 23, 2020 16:43
@j-ittner j-ittner added this to the 1.0.1 milestone Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants