Doxygen / Sphinx bridge, with autodoc and autosummary
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.
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
.. autodoxysummary:: :toctree: generated/ :template: doxyclass.rst OpenMM::CustomIntegrator OpenMM::CustomCompoundBondForce
This produces the output shown here
You can install it with pip (py27 or py33+):
pip install sphinxcontrib-autodoc_doxygen
The necessary dependences should be grabbed by pip. If you have trouble getting lxml, here are some tips:
If you use the Anaconda Python distribution, run conda install lxml. With the system package manager on linux, sudo apt-get install python-lxml or sudo yum install python-lxml should do the trick. On Windows, you may be able to download the lxml from Christoph Gohlke’s repository. On OS X, try the following long command brew install libxslt libxml2; LDFLAGS="-L/usr/local/opt/libxslt/lib -L/usr/local/opt/libxml2/lib" CPPFLAGS="-I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include" pip install lxml. It may take a long time (~5 minutes), but once the wheel is built, it will be cache, so you only need to do this once, even if switch virtualenvs.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|sphinxcontrib_autodoc_doxygen-0.3.2-py2.py3-none-any.whl (16.3 kB) Copy SHA256 hash SHA256||Wheel||py2.py3|
|sphinxcontrib-autodoc_doxygen-0.3.2.tar.gz (252.8 kB) Copy SHA256 hash SHA256||Source||None|