sphinxcontrib-autodoc-doxygen 0.1.0

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