Skip to main content

Sphinx extension: graphviz generation of external dot files

Project description

qubic.sphinx.graphvizinclude

Overview

This package defines an extension for the Sphinx documentation system. The extension allows generation of Graphviz from external .dot resources

Installation

Install via easy_install:

$ 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

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qubic.sphinx.graphvizinclude, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size qubic.sphinx.graphvizinclude-0.1.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page