Metadata-Version: 1.0
Name: qubic.sphinx.graphvizinclude
Version: 0.1
Summary: Sphinx extension: graphviz generation of external dot files
Home-page: UNKNOWN
Author: Nicolas Laurance
Author-email: nicolas[dot]laurance<at>gmail
License: MIT GPLv3
Description: 
        .. contents::
        
        qubic.sphinx.graphvizinclude
        ============================
        
        Overview
        --------
        
        This package defines an extension for the
        `Sphinx <http://sphinx.pocool.org>`_ documentation system.  The extension
        allows generation of Graphviz from external .dot resources
        
        
        Installation
        ------------
        
        Install via `easy_install
        <http://peak.telecommunity.com/DevCenter/EasyInstall>`_::
        
         $ bin/easy_install qubic.sphinx.graphvizinclude
        
        or any other means which gets the package on your ``PYTHONPATH``.
        
        
        Registering the Extension
        -------------------------
        
        Add ``qubic.sphinx.graphvizinclude`` to the ``extensions`` list in the
        ``conf.py`` of the Sphinx documentation for your product.  E.g.::
        
         extensions = ['sphinx.ext.autodoc',
                       'sphinx.ext.doctest',
                       'qubic.sphinx.graphvizinclude',
                      ]
        
        
        Using the Extension
        -------------------
        
        At appropriate points in your document, call out the interface
        autodocs via::
        
          .. graphvizinclude:: ./path_to/graph_definition.dot
        
        
        
        change history
        --------------
        
        0.1
        ~~~
        
        first release
Keywords: sphinx graphviz
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
