You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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
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.:
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
The text was updated successfully, but these errors were encountered: