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/
Raw data
{
"_id": null,
"home_page": "https://nbsphinx.readthedocs.io/",
"name": "nbsphinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Sphinx, Jupyter, notebook",
"author": "Matthias Geier",
"author_email": "Matthias.Geier@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/af/49/a6b1ed510bcc7734daa20372222804d6109d3087ced82f65c8720da90ef4/nbsphinx-0.9.5.tar.gz",
"platform": "any",
"description": "Jupyter Notebook Tools for Sphinx\n=================================\n\n``nbsphinx`` is a Sphinx_ extension that provides a source parser for\n``*.ipynb`` files.\nCustom Sphinx directives are used to show `Jupyter Notebook`_ code cells (and of\ncourse their results) in both HTML and LaTeX output.\nUn-evaluated notebooks -- i.e. notebooks without stored output cells -- will be\nautomatically executed during the Sphinx build process.\n\nQuick Start:\n #. Install ``nbsphinx``\n\n #. Edit your ``conf.py`` and add ``'nbsphinx'`` to ``extensions``.\n\n #. Edit your ``index.rst`` and add the names of your ``*.ipynb`` files\n to the ``toctree``.\n\n #. Run Sphinx!\n\nOnline documentation (and example of use):\n https://nbsphinx.readthedocs.io/\n\nSource code repository (and issue tracker):\n https://github.com/spatialaudio/nbsphinx/\n\nLicense:\n MIT -- see the file ``LICENSE`` for details.\n\n.. _Sphinx: https://www.sphinx-doc.org/\n.. _Jupyter Notebook: https://jupyter.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Jupyter Notebook Tools for Sphinx",
"version": "0.9.5",
"project_urls": {
"Bug Tracker": "https://github.com/spatialaudio/nbsphinx/issues/",
"Documentation": "https://nbsphinx.readthedocs.io/",
"Homepage": "https://nbsphinx.readthedocs.io/",
"Source Code": "https://github.com/spatialaudio/nbsphinx/"
},
"split_keywords": [
"sphinx",
" jupyter",
" notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae8a5a1e56efa95e2038de5646e2bc5c0abe18678ae5d167e267c0fbaa17a372",
"md5": "e6d680fb94e1afa67fedcd49b1af84bf",
"sha256": "d82f71084425db1f48e72515f15c25b4de8652ceaab513ee462ac05f1b8eae0a"
},
"downloads": -1,
"filename": "nbsphinx-0.9.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6d680fb94e1afa67fedcd49b1af84bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 31349,
"upload_time": "2024-08-13T16:58:21",
"upload_time_iso_8601": "2024-08-13T16:58:21.461491Z",
"url": "https://files.pythonhosted.org/packages/ae/8a/5a1e56efa95e2038de5646e2bc5c0abe18678ae5d167e267c0fbaa17a372/nbsphinx-0.9.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af49a6b1ed510bcc7734daa20372222804d6109d3087ced82f65c8720da90ef4",
"md5": "c1c36373c79893608ee818191e64afc1",
"sha256": "736916e7b0dab28fc904f4a9ae3b53a9a50c29fccc6329c052fcc7485abcf2b7"
},
"downloads": -1,
"filename": "nbsphinx-0.9.5.tar.gz",
"has_sig": false,
"md5_digest": "c1c36373c79893608ee818191e64afc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 179599,
"upload_time": "2024-08-13T16:58:23",
"upload_time_iso_8601": "2024-08-13T16:58:23.475987Z",
"url": "https://files.pythonhosted.org/packages/af/49/a6b1ed510bcc7734daa20372222804d6109d3087ced82f65c8720da90ef4/nbsphinx-0.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 16:58:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spatialaudio",
"github_project": "nbsphinx",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"circle": true,
"lcname": "nbsphinx"
}
JSON
