Skip to main content

Doxygen / Sphinx bridge, with autodoc and autosummary

Project description

https://travis-ci.org/rmcgibbo/sphinxcontrib-autodoc_doxygen.svg?branch=master

Example Output

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 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.

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

sphinxcontrib-autodoc_doxygen-0.7.0.tar.gz (254.1 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_autodoc_doxygen-0.7.0-py2.py3-none-any.whl (15.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-autodoc_doxygen-0.7.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib-autodoc_doxygen-0.7.0.tar.gz
  • Upload date:
  • Size: 254.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.8

File hashes

Hashes for sphinxcontrib-autodoc_doxygen-0.7.0.tar.gz
Algorithm Hash digest
SHA256 c07bfefd92f01aa9a4f022c52e1887e9c10be77a86ce9bd854708083f9601a16
MD5 b2fc93242ff461623d367129a8d9ee6a
BLAKE2b-256 7514d241348be9d1c568fd5855cec241b40e16809203964de00b29e1b0f65d2e

See more details on using hashes here.

Provenance

File details

Details for the file sphinxcontrib_autodoc_doxygen-0.7.0-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_autodoc_doxygen-0.7.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.8

File hashes

Hashes for sphinxcontrib_autodoc_doxygen-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0489ad2ef2fdd17dc413d07f2579d471bfca4f41b2fcc171a961f24d6217eff7
MD5 8f9bad77b972d6f860c13e985a4ec423
BLAKE2b-256 ae2ebbbba3c2c742c708b032caea70d4ca23f29a8c9a1f54bfb727aeac47795d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page