README.rst

Breathe

This is an extension to reStructuredText and Sphinx to be able to read and render the Doxygen xml output.

Download

Breathe is available from github and PyPI, the Python Package Index

Documentation

Documentation is available in the testsuite folder and up in full here.

Running Testsuite

Run make in the root of the project.

This will run doxygen over the example code and then run the Breathe documentation/testsuite. View the results at:

testsuite/build/html/index.html

Requirements

Development is currently done with:

• Python 2.7
• Docutils 0.7
• Sphinx 1.0.7
• Doxygen 1.7.2

Doxygen 1.5.1 seems to produce xml with repeated sections which causes Breathe some confusion. Not sure when this was resolved but it might be best to go for the latest possible.

Mailing List

There is a mailing list available thanks to LibreList:

[email protected]

The archives are available here.

Credits

Thank you to:

• nijel
• sebastianschaetz
• mbolivar
• queezythegreat
• abingham
• davidm
• hobu
• magro11
• scopatz
• vitaut
• vonj
• jmnas

For their contributions; improving the code and the documentation. And thanks to:

• Dimitri van Heesch for Doxygen.
• Georg Brandl for Sphinx.
• David Goodger for Docutils and reStructuredText.