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/8d/84/cb762ec2463d41c5bd9370bdeeab56153c363b232ff69f5dea2bf032a889/nbsphinx-0.9.4.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.4",
"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": "f0270aa888e25132542181350e38cb89467ad309ff369b10f6fbe8b57ca2a1a9",
"md5": "69dbec5d2fdc2b21c74abb7abc143b50",
"sha256": "22cb1d974a8300e8118ca71aea1f649553743c0c5830a54129dcd446e6a8ba17"
},
"downloads": -1,
"filename": "nbsphinx-0.9.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69dbec5d2fdc2b21c74abb7abc143b50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 31039,
"upload_time": "2024-05-06T19:29:47",
"upload_time_iso_8601": "2024-05-06T19:29:47.712679Z",
"url": "https://files.pythonhosted.org/packages/f0/27/0aa888e25132542181350e38cb89467ad309ff369b10f6fbe8b57ca2a1a9/nbsphinx-0.9.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d84cb762ec2463d41c5bd9370bdeeab56153c363b232ff69f5dea2bf032a889",
"md5": "518dbc88fa7a6df610a35692ca836475",
"sha256": "042a60806fc23d519bc5bef59d95570713913fe442fda759d53e3aaf62104794"
},
"downloads": -1,
"filename": "nbsphinx-0.9.4.tar.gz",
"has_sig": false,
"md5_digest": "518dbc88fa7a6df610a35692ca836475",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 179315,
"upload_time": "2024-05-06T19:29:49",
"upload_time_iso_8601": "2024-05-06T19:29:49.056234Z",
"url": "https://files.pythonhosted.org/packages/8d/84/cb762ec2463d41c5bd9370bdeeab56153c363b232ff69f5dea2bf032a889/nbsphinx-0.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 19:29:49",
"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
