{ "info": { "author": "Philipp Sommer", "author_email": "philipp.sommer@unil.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Documentation" ], "description": "=============================================================\nCreate an examples gallery with sphinx from Jupyter Notebooks\n=============================================================\n\n.. start-badges\n\n.. list-table::\n :stub-columns: 1\n :widths: 10 90\n\n * - docs\n - |docs|\n * - tests\n - |travis| |requires| |coveralls|\n * - package\n - |version| |conda| |github|\n * - implementations\n - |supported-versions| |supported-implementations|\n\n.. |docs| image:: http://readthedocs.org/projects/sphinx-nbexamples/badge/?version=latest\n :alt: Documentation Status\n :target: http://sphinx-nbexamples.readthedocs.io/en/latest/?badge=latest\n\n.. |travis| image:: https://travis-ci.org/Chilipp/sphinx-nbexamples.svg?branch=master\n :alt: Travis\n :target: https://travis-ci.org/Chilipp/sphinx-nbexamples\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/sphinx-nbexamples/badge.svg?branch=master\n :alt: Coverage\n :target: https://coveralls.io/github/Chilipp/sphinx-nbexamples?branch=master\n\n.. |requires| image:: https://requires.io/github/Chilipp/sphinx-nbexamples/requirements.svg?branch=master\n :alt: Requirements Status\n :target: https://requires.io/github/Chilipp/sphinx-nbexamples/requirements/?branch=master\n\n.. |version| image:: https://img.shields.io/pypi/v/sphinx-nbexamples.svg?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.org/project/sphinx-nbexamples/\n\n.. |conda| image:: https://anaconda.org/conda-forge/sphinx-nbexamples/badges/version.svg\n :alt: conda\n :target: https://anaconda.org/conda-forge/sphinx-nbexamples\n\n.. |github| image:: https://img.shields.io/github/release/Chilipp/sphinx-nbexamples.svg\n :target: https://github.com/Chilipp/sphinx-nbexamples/releases/latest\n :alt: Latest github release\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-nbexamples.svg?style=flat\n :alt: Supported versions\n :target: https://pypi.org/project/sphinx-nbexamples/\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-nbexamples.svg?style=flat\n :alt: Supported implementations\n :target: https://pypi.org/project/sphinx-nbexamples/\n\n\n.. end-badges\n\nWelcome! Similarly to Oscar Najeras sphinx-gallery_ module, this module intends\nto create an example gallery for your documentation. However, we don't use\npython scripts, instead we create the example gallery out of a bunch of jupyter\nnotebooks using nbconvert.\n\nThis package can be used to\n\n1. Put all the examples you prepared in different notebooks in an pictured\n gallery\n2. use the same html (sphinx) scheme for your examples that you are using for\n your documentation\n3. Include the example notebooks in an offline (pdf) documentation\n4. Include not only the code, but also the link to required supplementary files\n5. Include a link to the `Jupyter nbviewer`_\n\n.. _Jupyter nbviewer: https://nbviewer.jupyter.org\n.. _sphinx-gallery: http://sphinx-gallery.readthedocs.org/en/latest/\n\n\n\nInstallation\n============\nSimply install it via ``pip``::\n\n $ pip install sphinx-nbexamples\n\nOr you install it via::\n\n $ python setup.py install\n\nfrom the `source on GitHub`_.\n\n\n.. _source on GitHub: https://github.com/Chilipp/sphinx-nbexamples\n\n\nRequirements\n============\nThe package requires\n\n- Sphinx_>=1.3: The python library for generating automated documentation\n- jupyter_: The jupyter framework for jupyter notebooks. sphinx-nbexamples\n explicitly depends on\n\n - nbconvert_: For converting jupyter notebooks to RST\n - jupyter_client_: For managing the kernels\n - ipykernel_: For installing an ipython kernel and run the notebooks\n\n\n.. _Sphinx: http://www.sphinx-doc.org/en/stable\n.. _jupyter: http://jupyter.org/\n.. _nbconvert: https://nbconvert.readthedocs.io\n.. _jupyter_client: https://jupyter-client.readthedocs.io\n.. _ipykernel: https://ipykernel.readthedocs.io", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Chilipp/sphinx-nbexamples", "keywords": "sphinx sphinx-gallery examples documentation notebook ipython jupyter nbconvert nbsphinx", "license": "GPLv2", "maintainer": "", "maintainer_email": "", "name": "sphinx-nbexamples", "package_url": "https://pypi.org/project/sphinx-nbexamples/", "platform": "", "project_url": "https://pypi.org/project/sphinx-nbexamples/", "project_urls": { "Homepage": "https://github.com/Chilipp/sphinx-nbexamples" }, "release_url": "https://pypi.org/project/sphinx-nbexamples/0.4.0/", "requires_dist": null, "requires_python": "", "summary": "Create an examples gallery with sphinx from Jupyter Notebooks", "version": "0.4.0" }, "last_serial": 5285391, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "cfc0e4d9d8c812ca401bc32915a7a74c", "sha256": "dfbe82694d024157d8543e747f8ac40d4d65280bafad1cf319c2d8807123139d" }, "downloads": -1, "filename": "sphinx-nbexamples-0.1.1.tar.gz", "has_sig": false, "md5_digest": "cfc0e4d9d8c812ca401bc32915a7a74c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20745, "upload_time": "2016-10-25T14:31:30", "url": "https://files.pythonhosted.org/packages/1a/44/ba508881e845bb8d76a3bbafe214b3e31d3f7a425b0983710efb2e7aeb5d/sphinx-nbexamples-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "a66009e291d7d69c920f36f8ee78d34e", "sha256": "596af3c625ca5f230c76df47d7cc173c05b825dd578a8a4d3628d21efa97be39" }, "downloads": -1, "filename": "sphinx-nbexamples-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a66009e291d7d69c920f36f8ee78d34e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20798, "upload_time": "2017-02-07T13:07:56", "url": "https://files.pythonhosted.org/packages/a6/5c/6c6860fcdd13ace6b779561edc1e63fd6729a84241bd5b1d501c406ce1ad/sphinx-nbexamples-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "c715903c6189a0008dcf8b0e36f55203", "sha256": "ad7e585bd11183cb3ddb645c3f3efd92d588cb4c75a7399b8acec9d6ff310600" }, "downloads": -1, "filename": "sphinx-nbexamples-0.1.3.tar.gz", "has_sig": false, "md5_digest": "c715903c6189a0008dcf8b0e36f55203", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27846, "upload_time": "2017-03-11T13:12:33", "url": "https://files.pythonhosted.org/packages/75/37/514bdc228d1213d5a5984c76710e13f5caf14641dee9adfd52d094ccedeb/sphinx-nbexamples-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "6d76345f9e56bb48f02b3a29b624797c", "sha256": "96d523e24c298f1a3a5b1583e685d463d3f96a1b8ec33321d1e69d8b144cf929" }, "downloads": -1, "filename": "sphinx-nbexamples-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6d76345f9e56bb48f02b3a29b624797c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28648, "upload_time": "2017-07-19T07:17:33", "url": "https://files.pythonhosted.org/packages/99/1a/248763dcb2e22bcdc3133ceaaba0c8f1f2ee0b96e7fa37534dd736f399cf/sphinx-nbexamples-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "7d5925441cb9f38290c4113fee753b68", "sha256": "17868155d513d79a242c05ec4361d2ea13dd73b910ef8358da8b9590e3257024" }, "downloads": -1, "filename": "sphinx-nbexamples-0.2.1.tar.gz", "has_sig": false, "md5_digest": "7d5925441cb9f38290c4113fee753b68", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28651, "upload_time": "2017-07-19T07:47:41", "url": "https://files.pythonhosted.org/packages/f7/85/22130e3d1d27a5d7b38a0767c134c83ccf296339d0a41c9743cd622e7ebb/sphinx-nbexamples-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "6ae3a1e37ef571310cdaaf421edb59d3", "sha256": "fb11e885444bb6d1e0ee6ee128380c1249d05dbd63371d9b9be3ddcfc0946535" }, "downloads": -1, "filename": "sphinx-nbexamples-0.2.2.tar.gz", "has_sig": false, "md5_digest": "6ae3a1e37ef571310cdaaf421edb59d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29072, "upload_time": "2017-07-27T09:12:58", "url": "https://files.pythonhosted.org/packages/9c/3e/b6a2e773b1f7a0ad2561ef2bbc4ac7fd84e5f9a00290aace22e5b644bb93/sphinx-nbexamples-0.2.2.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "973e660a84c601663b8bcde3a131f890", "sha256": "ab52bc9817914469f2fa6846283e59dd7ea8d5a93768527dbab72d6b5227c6f2" }, "downloads": -1, "filename": "sphinx-nbexamples-0.3.0.tar.gz", "has_sig": false, "md5_digest": "973e660a84c601663b8bcde3a131f890", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29721, "upload_time": "2018-04-13T08:35:08", "url": "https://files.pythonhosted.org/packages/9b/60/0ef9e73d7cf372e68cd67af001475af76d9964b002e16965442d05a04546/sphinx-nbexamples-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "b42b85209117010ec5f99bd7c28664ac", "sha256": "3e1b1fd33cdcd33613b1e9d5543c58c87cd44bb48f4b7afcb7bf8183206a5a88" }, "downloads": -1, "filename": "sphinx-nbexamples-0.3.1.tar.gz", "has_sig": false, "md5_digest": "b42b85209117010ec5f99bd7c28664ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29743, "upload_time": "2018-12-16T17:34:59", "url": "https://files.pythonhosted.org/packages/f7/be/b19651bb98473d2c411f0add09317d8e22447c34d35429e74650d542a55b/sphinx-nbexamples-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "80eebe7a0f1e7ca65f49110b378bc487", "sha256": "99f50cd2d9c5b7738b12d84a5583dcd231510903f05b2cdcdd2d53fd5ca612d8" }, "downloads": -1, "filename": "sphinx-nbexamples-0.3.2.tar.gz", "has_sig": false, "md5_digest": "80eebe7a0f1e7ca65f49110b378bc487", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29653, "upload_time": "2019-05-13T12:43:26", "url": "https://files.pythonhosted.org/packages/e7/4f/66e43d52741e21d4a21d350f9233f6fbda8094b5ff8eaa0d5c82182f5343/sphinx-nbexamples-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "fab422e69280b79057e13e1db8e0b6f0", "sha256": "14b6b3864aa65d83d1d31fe3e2dcd17165ae18c1e083328a132145d35a20b732" }, "downloads": -1, "filename": "sphinx-nbexamples-0.4.0.tar.gz", "has_sig": false, "md5_digest": "fab422e69280b79057e13e1db8e0b6f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30576, "upload_time": "2019-05-18T09:47:02", "url": "https://files.pythonhosted.org/packages/38/e2/6eb045d5832002ae2511d844ec8a33b9ca66279be0368b2b2851c9bab353/sphinx-nbexamples-0.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fab422e69280b79057e13e1db8e0b6f0", "sha256": "14b6b3864aa65d83d1d31fe3e2dcd17165ae18c1e083328a132145d35a20b732" }, "downloads": -1, "filename": "sphinx-nbexamples-0.4.0.tar.gz", "has_sig": false, "md5_digest": "fab422e69280b79057e13e1db8e0b6f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30576, "upload_time": "2019-05-18T09:47:02", "url": "https://files.pythonhosted.org/packages/38/e2/6eb045d5832002ae2511d844ec8a33b9ca66279be0368b2b2851c9bab353/sphinx-nbexamples-0.4.0.tar.gz" } ] }