Metadata-Version: 1.1
Name: sphinx-nbexamples
Version: 0.2.2
Summary: Create an examples gallery with sphinx from Jupyter Notebooks
Home-page: https://github.com/Chilipp/sphinx-nbexamples
Author: Philipp Sommer
Author-email: philipp.sommer@unil.ch
License: GPLv2
Description: =============================================================
        Create an examples gallery with sphinx from Jupyter Notebooks
        =============================================================
        
        .. start-badges
        
        .. list-table::
            :stub-columns: 1
            :widths: 10 90
        
            * - docs
              - |docs|
            * - tests
              - |travis| |requires| |coveralls|
            * - package
              - |version| |supported-versions| |supported-implementations|
        
        .. |docs| image:: http://readthedocs.org/projects/sphinx-nbexamples/badge/?version=latest
            :alt: Documentation Status
            :target: http://sphinx-nbexamples.readthedocs.io/en/latest/?badge=latest
        
        .. |travis| image:: https://travis-ci.org/Chilipp/sphinx-nbexamples.svg?branch=master
            :alt: Travis
            :target: https://travis-ci.org/Chilipp/sphinx-nbexamples
        
        .. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/sphinx-nbexamples/badge.svg?branch=master
            :alt: Coverage
            :target: https://coveralls.io/github/Chilipp/sphinx-nbexamples?branch=master
        
        .. |requires| image:: https://requires.io/github/Chilipp/sphinx-nbexamples/requirements.svg?branch=master
            :alt: Requirements Status
            :target: https://requires.io/github/Chilipp/sphinx-nbexamples/requirements/?branch=master
        
        .. |version| image:: https://img.shields.io/pypi/v/sphinx-nbexamples.svg?style=flat
            :alt: PyPI Package latest release
            :target: https://pypi.python.org/pypi/sphinx-nbexamples
        
        .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-nbexamples.svg?style=flat
            :alt: Supported versions
            :target: https://pypi.python.org/pypi/sphinx-nbexamples
        
        .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-nbexamples.svg?style=flat
            :alt: Supported implementations
            :target: https://pypi.python.org/pypi/sphinx-nbexamples
        
        
        .. end-badges
        
        Welcome! Similarly to Oscar Najeras sphinx-gallery_ module, this module intends
        to create an example gallery for your documentation. However, we don't use
        python scripts, instead we create the example gallery out of a bunch of jupyter
        notebooks using nbconvert.
        
        This package can be used to
        
        1. Put all the examples you prepared in different notebooks in an pictured
           gallery
        2. use the same html (sphinx) scheme for your examples that you are using for
           your documentation
        3. Include the example notebooks in an offline (pdf) documentation
        4. Include not only the code, but also the link to required supplementary files
        5. Include a link to the `Jupyter nbviewer`_
        
        .. _Jupyter nbviewer: https://nbviewer.jupyter.org
        .. _sphinx-gallery: http://sphinx-gallery.readthedocs.org/en/latest/
        
        
        
        Installation
        ============
        Simply install it via ``pip``::
        
            $ pip install sphinx-nbexamples
        
        Or you install it via::
        
            $ python setup.py install
        
        from the `source on GitHub`_.
        
        
        .. _source on GitHub: https://github.com/Chilipp/sphinx-nbexamples
        
        
        Requirements
        ============
        The package only requires Sphinx_, ipython and nbconvert to be installed. It
        has been tested for versions higher than 1.3.
        
        
        .. _Sphinx: http://www.sphinx-doc.org/en/stable
        
Keywords: sphinx sphinx-gallery examples documentation notebook ipython jupyter nbconvert nbsphinx
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: OS Independent
