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

Beautify Notebooks and Integrate into Sphinx Documentation as Tutorials #25

Open
MarcoHuebner opened this issue Nov 1, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@MarcoHuebner
Copy link
Collaborator

MarcoHuebner commented Nov 1, 2023

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:

  • Improve the readability and visual appeal of the Jupyter Notebooks by adding more markdown sections

Integration into Sphinx Documentation:

  • Add a 'Tutorials' section to the documentation
  • Render the beautified notebooks in the Sphinx documentation 'Tutorials' section.
@MarcoHuebner MarcoHuebner added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 1, 2023
@sjockers
Copy link
Collaborator

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
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants