-
Notifications
You must be signed in to change notification settings - Fork 1
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
Beautify Notebooks and Integrate into Sphinx Documentation as Tutorials #25
Labels
Comments
MarcoHuebner
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
labels
Nov 1, 2023
See Sphinx docs: https://docs.readthedocs.io/en/stable/guides/jupyter.html |
MarcoHuebner
added a commit
that referenced
this issue
Sep 18, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 18, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 18, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 19, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 19, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 20, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 20, 2024
MarcoHuebner
added a commit
that referenced
this issue
Sep 20, 2024
MarcoHuebner
added a commit
that referenced
this issue
Oct 15, 2024
* Update dependencies, pre-commit, and add pandoc (instructions) #25 * Update docu creation and deployment workflow for nbsphinx #25 * Update headings for compatibility with nbsphinx/ docu rendering #25 * Incorporate coderabbit suggestions #25 * Update dependencies to fix safety issues for jupyterlab and notebook (not jinja) #25 * Rename notebooks, clean-up headings #25 * Attempt to fix case-sensitivity problem by renaming twice #25 * Attempt to fix case-sensitivity problem by renaming twice #25
pmayd
pushed a commit
that referenced
this issue
Oct 21, 2024
* Update dependencies, pre-commit, and add pandoc (instructions) #25 * Update docu creation and deployment workflow for nbsphinx #25 * Update headings for compatibility with nbsphinx/ docu rendering #25 * Incorporate coderabbit suggestions #25 * Update dependencies to fix safety issues for jupyterlab and notebook (not jinja) #25 * Rename notebooks, clean-up headings #25 * Attempt to fix case-sensitivity problem by renaming twice #25 * Attempt to fix case-sensitivity problem by renaming twice #25
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Our Jupyter notebooks currently lack a polished appearance, and we're missing an opportunity to showcase them effectively in our Sphinx documentation. Beautifying the notebooks by adding explaining markdown sections and seamlessly integrating them into our documentation will enhance the overall presentation and provide a more engaging experience for users and contributors.
Implementation Steps:
Notebook Beautification:
Integration into Sphinx Documentation:
The text was updated successfully, but these errors were encountered: