ReStructuredText and Sphinx bridge to Doxygen
.. image:: https://github.com/michaeljones/breathe/workflows/unit%20tests/badge.svg :target: https://github.com/michaeljones/breathe/actions?query=workflow%3A%22unit+tests%22
This is an extension to reStructuredText and Sphinx to be able to read and render the Doxygen xml output.
Breathe is available from github and
PyPI, the Python Package Index_. It can be installed with::
pip install breathe
Breathe packages on PyPI are PGP signed for Breathe >= v4.28.0.
Breathe tarballs on GitHub are PGP signed for Breathe >= v4.29.0.
The documentation is available
here_. Thank you to the people running
Read the Docsfor such an excellent service.
The source for the documentation is in the
documentationfolder if you want to built it and read it locally.
The testsuite can be run with::
The documentation also does a good effort of covering the available functionality with different examples. To build the documentation, run::
This will run doxygen over the example code and then run the Breathe documentation. View the results at::
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
comparescript in the
documentationfolder. 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
HEADso 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
meldagainst the resulting directories so you can see the differences introduced by your branch.
Breathe requires Python 3.6+, Sphinx 3.0+ and Doxygen 1.8+.
The archive for the Google groups list can be found
The previous mailing list was on
librelist.com__ and the archives are available
Please post new questions as GitHub issues.
Examples of Breathe used by other projects:
Lasso C API_ [
If you have an example you would like listed here, please make a github issue with the details.
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.
mkreleaseutility in the root of the repository.
Useful vim command for changelog conversion to the git tag format:
Breathe is currently maintained byvermeeren_ and was formerly maintained bymichaeljones_ &vitaut_, contributors include:
Docutils_ and reStructuredText.