nbsphinx


Namenbsphinx JSON
Version 0.9.6 PyPI version JSON
download
home_pagehttps://nbsphinx.readthedocs.io/
SummaryJupyter Notebook Tools for Sphinx
upload_time2024-12-24 09:30:33
maintainerNone
docs_urlNone
authorMatthias Geier
requires_python>=3.6
licenseMIT
keywords sphinx jupyter notebook
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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/62/38/6f6a0f9115b493af9d69b68335945827dd46e09de8ef525d1f58cd0870dc/nbsphinx-0.9.6.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.6",
    "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": "6a8a5dc4c8794053572a89f5c44437ef4e870f88903a6b6734500af1286f9018",
                "md5": "451d3259dc7d7e3530aa7fc701f6655a",
                "sha256": "336b0b557945a7678ec7449b16449f854bc852a435bb53b8a72e6b5dc740d992"
            },
            "downloads": -1,
            "filename": "nbsphinx-0.9.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "451d3259dc7d7e3530aa7fc701f6655a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 31582,
            "upload_time": "2024-12-24T09:30:30",
            "upload_time_iso_8601": "2024-12-24T09:30:30.030414Z",
            "url": "https://files.pythonhosted.org/packages/6a/8a/5dc4c8794053572a89f5c44437ef4e870f88903a6b6734500af1286f9018/nbsphinx-0.9.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "62386f6a0f9115b493af9d69b68335945827dd46e09de8ef525d1f58cd0870dc",
                "md5": "5f80df181615c57fa51b8448fc8c5050",
                "sha256": "c2b28a2d702f1159a95b843831798e86e60a17fc647b9bff9ba1585355de54e3"
            },
            "downloads": -1,
            "filename": "nbsphinx-0.9.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5f80df181615c57fa51b8448fc8c5050",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 180213,
            "upload_time": "2024-12-24T09:30:33",
            "upload_time_iso_8601": "2024-12-24T09:30:33.426413Z",
            "url": "https://files.pythonhosted.org/packages/62/38/6f6a0f9115b493af9d69b68335945827dd46e09de8ef525d1f58cd0870dc/nbsphinx-0.9.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-24 09:30:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "spatialaudio",
    "github_project": "nbsphinx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "lcname": "nbsphinx"
}
        
Elapsed time: 1.35005s