myst-nb


Namemyst-nb JSON
Version 1.2.0 PyPI version JSON
download
home_pageNone
SummaryA Jupyter Notebook Sphinx reader built on top of the MyST markdown parser.
upload_time2025-02-07 18:27:02
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords markdown lexer parser jupyter docutils sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MyST-NB

[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![PyPI][pypi-badge]][pypi-link]
[![Conda Version][conda-badge]][conda-link]

A collection of tools for working with Jupyter Notebooks in Sphinx.

The primary tool this package provides is a Sphinx parser for `ipynb` files.
This allows you to directly convert Jupyter Notebooks into Sphinx documents.
It relies heavily on the [`MyST` parser](https://github.com/executablebooks/myst-parser).

For more information, [see the MyST-NB documentation](https://myst-nb.readthedocs.io/en/latest/)

## Contributing

We welcome all contributions!
See the [Contributing Guide](https://myst-nb.readthedocs.io/en/latest/reference/contributing.html) for more details.

[github-ci]: https://github.com/executablebooks/MyST-NB/workflows/continuous-integration/badge.svg?branch=master
[github-link]: https://github.com/executablebooks/MyST-NB
[rtd-badge]: https://readthedocs.org/projects/myst-nb/badge/?version=latest
[rtd-link]: https://myst-nb.readthedocs.io/en/latest/?badge=latest
[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-NB/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/MyST-NB
[pypi-badge]: https://img.shields.io/pypi/v/myst-nb.svg
[pypi-link]: https://pypi.org/project/myst-nb
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/myst-nb.svg
[conda-link]: https://anaconda.org/conda-forge/myst-nb

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "myst-nb",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Angus Hollands <goosey15@gmail.com>",
    "keywords": "markdown, lexer, parser, jupyter, docutils, sphinx",
    "author": null,
    "author_email": "ExecutableBookProject <chrisj_sewell@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ae/8f/71d983ed85b1aff17db25e447a9beb67b50a9116c7cff5cde26796d1ffd0/myst_nb-1.2.0.tar.gz",
    "platform": null,
    "description": "# MyST-NB\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![PyPI][pypi-badge]][pypi-link]\n[![Conda Version][conda-badge]][conda-link]\n\nA collection of tools for working with Jupyter Notebooks in Sphinx.\n\nThe primary tool this package provides is a Sphinx parser for `ipynb` files.\nThis allows you to directly convert Jupyter Notebooks into Sphinx documents.\nIt relies heavily on the [`MyST` parser](https://github.com/executablebooks/myst-parser).\n\nFor more information, [see the MyST-NB documentation](https://myst-nb.readthedocs.io/en/latest/)\n\n## Contributing\n\nWe welcome all contributions!\nSee the [Contributing Guide](https://myst-nb.readthedocs.io/en/latest/reference/contributing.html) for more details.\n\n[github-ci]: https://github.com/executablebooks/MyST-NB/workflows/continuous-integration/badge.svg?branch=master\n[github-link]: https://github.com/executablebooks/MyST-NB\n[rtd-badge]: https://readthedocs.org/projects/myst-nb/badge/?version=latest\n[rtd-link]: https://myst-nb.readthedocs.io/en/latest/?badge=latest\n[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-NB/branch/master/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/MyST-NB\n[pypi-badge]: https://img.shields.io/pypi/v/myst-nb.svg\n[pypi-link]: https://pypi.org/project/myst-nb\n[conda-badge]: https://img.shields.io/conda/vn/conda-forge/myst-nb.svg\n[conda-link]: https://anaconda.org/conda-forge/myst-nb\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser.",
    "version": "1.2.0",
    "project_urls": {
        "Documentation": "https://myst-nb.readthedocs.io",
        "Homepage": "https://github.com/executablebooks/myst-nb"
    },
    "split_keywords": [
        "markdown",
        " lexer",
        " parser",
        " jupyter",
        " docutils",
        " sphinx"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4098fa9dee0caf4e1f2e895d047952bf84a64eb95102df14c82c20594c0afa5f",
                "md5": "5e29f26c87e449a714916e13f2b0bdff",
                "sha256": "0e09909877848c0cf45e1aecee97481512efa29a0c4caa37870a03bba11c56c1"
            },
            "downloads": -1,
            "filename": "myst_nb-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5e29f26c87e449a714916e13f2b0bdff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 80303,
            "upload_time": "2025-02-07T18:27:00",
            "upload_time_iso_8601": "2025-02-07T18:27:00.088258Z",
            "url": "https://files.pythonhosted.org/packages/40/98/fa9dee0caf4e1f2e895d047952bf84a64eb95102df14c82c20594c0afa5f/myst_nb-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ae8f71d983ed85b1aff17db25e447a9beb67b50a9116c7cff5cde26796d1ffd0",
                "md5": "950ecc2e3474fdfb181b8152f939f32b",
                "sha256": "af459ec753b341952182b45b0a80b4776cebf80c9ee6aaca2a3f4027b440c9de"
            },
            "downloads": -1,
            "filename": "myst_nb-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "950ecc2e3474fdfb181b8152f939f32b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 79446,
            "upload_time": "2025-02-07T18:27:02",
            "upload_time_iso_8601": "2025-02-07T18:27:02.176925Z",
            "url": "https://files.pythonhosted.org/packages/ae/8f/71d983ed85b1aff17db25e447a9beb67b50a9116c7cff5cde26796d1ffd0/myst_nb-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-07 18:27:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "executablebooks",
    "github_project": "myst-nb",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "myst-nb"
}
        
Elapsed time: 2.50269s