Doxygen / Sphinx bridge, with autodoc and autosummary
Project description
This a (pre-alpha) extension for sphinx that to read and display Doxygen XML output. It is similar to Breathe. The implementation extends sphinx.ext.autodoc and sphinx.ext.autosummary as closely as possble.
Usage
In your Sphinx conf.py` add ``'sphinxcontrib.autodoc_doxygen' to the list of extensions, and set the variable doxygen_xml to a string containing the path to the directory containing your Doxygen XML output.
This adds the following RST directives.
autodoxysummary autodoxyclass autodoxymethod autodoxyenum
Examples
.. autodoxysummary:: :toctree: generated/ :template: doxyclass.rst OpenMM::CustomIntegrator OpenMM::CustomCompoundBondForce
This produces the output shown here
Installation
You can install it with pip (py27 or py33+):
pip install git+https://github.com/rmcgibbo/sphinxcontrib-autodoc_doxygen.git
Dependecies with Conda (cross-platform)
conda install sphinx six lxml
Dependencies with linux system package manager (e.g. with /usr/local/bin/python):
# debian sudo apt-get install python-setuptools python-lxml python-sphinx python-pip # or, for fedora sudo yum install python-setuptools python-lxml python-sphinx python-pip
Dependencies with Windows
If you use windows, I receommend using conda. If not, you may be able to download the lxml dependency from Christoph Gohlke’s repository
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-autodoc_doxygen-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 005da555be15061779431e9432e36d64a12d77a669b401f987cec520f0751472 |
|
MD5 | 40852eb41fecddc92c39662a69aaca7b |
|
BLAKE2b-256 | e9b830277a0b44a5fe18f2a015b23cbfdab9ddcf753dba80a4257ae056d797a7 |
Hashes for sphinxcontrib_autodoc_doxygen-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f958b39938420b044423600c6d802bd2cbfdd978b70683a62fd1ad1b356677b6 |
|
MD5 | f0ed81cab02dcf85ba0a46d2fdfe56a6 |
|
BLAKE2b-256 | ff83509126b1e33a81d06773df1ab82936d31c6446386afece60fc6a22999b71 |