Breathe

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

Install

Breathe is available from github and PyPI, the Python Package Index. It can be installed with:

pip install breathe

Packagers

Breathe packages on PyPI are PGP signed for Breathe >= v4.28.0.

Breathe tarballs on GitHub are PGP signed for Breathe >= v4.29.0.

Documentation

The documentation is available here. Thank you to the people running Read the Docs for such an excellent service.

The source for the documentation is in the documentation folder if you want to built it and read it locally.

Testing

The testsuite can be run with:

make dev-test

The documentation also does a good effort of covering the available functionality with different examples. To build the documentation, run:

make

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

documentation/build/html/index.html

Further to this if you want to compare the current documentation output against a previous state in order to check for regressions there is a compare script in the documentation folder. It takes two arguments which are two commit references that you'd like to compare. This means that all your changes have to be committed first. Also the script does not resolve state dependent references like HEAD so provide concrete commit references like sha1s or branch names. A typical example is to compare your current branch output to master:

# Make sure all your changes are committed first
cd documentation
./compare master my-branch

This will do a checkout and build at each commit and then run meld against the resulting directories so you can see the differences introduced by your branch.

Requirements

Breathe requires Python 3.6+, Sphinx 3.0+ and Doxygen 1.8+.

Mailing List Archives

The archive for the Google groups list can be found here.

The previous mailing list was on librelist.com and the archives are available here.

Please post new questions as GitHub issues.

Examples

Examples of Breathe used by other projects:

• fmt
• Lasso C API [pdf]

If you have an example you would like listed here, please make a github issue with the details.

Alternatives

Breathe is not the only solution to this problem. These are the alternatives that we know about. We are very happy to list others if you'd like to provide a link in a GitHub issue.

• Gasp
• Robin
• sphinxcontrib-autodoc_doxygen

Release

See the mkrelease utility in the root of the repository.

Useful vim command for changelog conversion to the git tag format: %s/\v`(#[0-9]+) \<[^`]*`__/\1/g.

Credits

Breathe is currently maintained by vermeeren and was formerly maintained by michaeljones & vitaut, contributors include:

• nijel
• sebastianschaetz
• mbolivar
• queezythegreat
• abingham
• davidm
• hobu
• magro11
• scopatz
• vonj
• jmnas
• donkopotamus
• jo3w4rd
• Anthony Truchet
• Daniel Matz
• Andrew Hundt
• sebastinas
• robo9k
• sieben
• rweickelt
• sam-roth
• bnewbold
• serge-sans-paille
• dean0x7d
• Andne
• Tiwalun
• eric-wieser
• olitheolix
• Many more, this list is rather outdated. Refer to the git history.

Thanks to:

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

Changelog

See the CHANGELOG.rst