https://github.com/spatialaudio/nbsphinx

:ledger: Sphinx source parser for Jupyter notebooks
https://github.com/spatialaudio/nbsphinx

jupyter-notebook sphinx-doc sphinx-extension

Last synced: 7 days ago
JSON representation

:ledger: Sphinx source parser for Jupyter notebooks

• Host: GitHub
• URL: https://github.com/spatialaudio/nbsphinx
• Owner: spatialaudio
• License: mit
• Created: 2015-11-17T22:32:56.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-26T08:57:45.000Z (3 months ago)
• Last Synced: 2024-10-29T15:13:00.130Z (3 months ago)
• Topics: jupyter-notebook, sphinx-doc, sphinx-extension
• Language: Python
• Homepage: https://nbsphinx.readthedocs.io/
• Size: 1.23 MB
• Stars: 456
• Watchers: 10
• Forks: 130
• Open Issues: 109
• Metadata Files:
  • Readme: README.rst
  • Changelog: NEWS.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Jupyter Notebook Tools for Sphinx

=================================

``nbsphinx`` is a Sphinx_ extension that provides a source parser for

``*.ipynb`` files.

Custom Sphinx directives are used to show `Jupyter Notebook`_ code cells (and of

course their results) in both HTML and LaTeX output.

Un-evaluated notebooks -- i.e. notebooks without stored output cells -- will be

automatically executed during the Sphinx build process.

Quick Start:

    #. Install ``nbsphinx``

    #. Edit your ``conf.py`` and add ``'nbsphinx'`` to ``extensions``.

    #. Edit your ``index.rst`` and add the names of your ``*.ipynb`` files

       to the ``toctree``.

    #. Run Sphinx!

Online documentation (and example of use):

    https://nbsphinx.readthedocs.io/

Source code repository (and issue tracker):

    https://github.com/spatialaudio/nbsphinx/

License:

    MIT -- see the file ``LICENSE`` for details.

.. _Sphinx: https://www.sphinx-doc.org/

.. _Jupyter Notebook: https://jupyter.org/