Metadata-Version: 1.1
Name: nbsphinx
Version: 0.2.0
Summary: Jupyter Notebook Tools for Sphinx
Home-page: http://nbsphinx.rtfd.org/
Author: Matthias Geier
Author-email: Matthias.Geier@gmail.com
License: MIT
Description: 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.
        
        .. _Sphinx: http://sphinx-doc.org/
        .. _Jupyter Notebook: http://jupyter.org/
        
        Documentation (and example of use):
            http://nbsphinx.rtfd.org/
        
        Code:
            http://github.com/spatialaudio/nbsphinx/
        
        Python Package Index:
            https://pypi.python.org/pypi/nbsphinx/
        
        License:
            MIT -- see the file ``LICENSE`` for details.
        
        Quick Start:
            #. Install ``nbsphinx`` with pip_::
        
                   pip install nbsphinx --user
        
               ... or, if you prefer, just copy the file ``nbsphinx.py`` your Sphinx
               directory.
        
            #. Edit your ``conf.py`` and add ``'nbsphinx'`` to ``extensions``.
        
            #. Edit your ``index.rst`` and add the names of your ``*.ipynb`` files
               (without the ``.ipynb`` extension) to the ``toctree`` directive.
        
            #. Run Sphinx!
        
        .. _pip: https://pip.pypa.io/en/latest/installing/
        
Keywords: Sphinx,Jupyter,notebook
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Sphinx
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation :: Sphinx
