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

Add links to Jupyter notebooks on GitHub at the top of Sphinx tutorials #46

Closed
rgriff23 opened this issue Jul 5, 2024 · 0 comments
Closed
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rgriff23
Copy link
Contributor

rgriff23 commented Jul 5, 2024

Problem

The tutorials in our Sphinx documentation are HTML pages built from Jupyter notebooks. Readers may want to download the Jupyter notebook so they can run the code, but it isn't clear where they can find the notebook.

Solution

Within each notebook tutorial, include a hyperlink to the Jupyter notebook on GitHub. From GitHub, the user can choose to download the notebook and explore related files (e.g., data or cache files which are used by the notebook).

Details

Place hyperlinks just beneath the main title of notebooks, e.g.:

# Building Your First ARTKIT Pipeline

[View notebook on GitHub](https://github.com/BCG-X-Official/artkit/blob/1.0.x/sphinx/source/user_guide/introduction_to_artkit/building_your_first_artkit_pipeline.ipynb)

Add hyperlinks to all Jupyter notebooks which are included in the User Guide and Examples sections of the Sphinx documentation.

In the artkit GitHub repo, you can find these files within:

  • sphinx/source/user_guide/
  • sphinx/source/examples/

Verifying your changes

  • Double check that you included correct hyperlinks for all notebook tutorials in the User Guide and Examples
  • Note that some docs pages are built from RST files instead of notebooks (e.g., the index pages for the User Guide and Examples, the intro to Gen AI Testing and Evaluation in the User Guide). These pages do not need hyperlinks.
@rgriff23 rgriff23 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 5, 2024
@rgriff23 rgriff23 changed the title Add links to Jupyter notebooks on GitHub at the top of Sphinx notebook tutorials Add links to Jupyter notebooks on GitHub at the top of Sphinx tutorials Jul 5, 2024
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant