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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for qubic.sphinx.graphvizinclude-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61df0fa5373dd02d8911e04de02699802e97e8790fc0b78f048272a0e2992a3d |
|
MD5 | 3571f1c13356ebcac3f27912e404d6b5 |
|
BLAKE2b-256 | c5ed175d43784ca6c58c61190e05ddb2a8026a6db1cf0ccb7738b8b5f74637b2 |