They've been there for a while (I think I wrote them both a while ago) and they don't necessarily reflect the degree of professionalism that would be good to bring to the project given that it is used quite widely at this point.
|1 year ago|
|.github/workflows||1 year ago|
|breathe||1 year ago|
|documentation||1 year ago|
|examples||1 year ago|
|requirements||1 year ago|
|tests||1 year ago|
|.gitignore||2 years ago|
|.readthedocs.yaml||2 years ago|
|CHANGELOG.rst||1 year ago|
|CONTRIBUTING.rst||1 year ago|
|LICENSE||7 years ago|
|Makefile||1 year ago|
|README.rst||1 year ago|
|breathe-apidoc.py||7 years ago|
|mkrelease||1 year ago|
|mypy.ini||2 years ago|
|setup.cfg||3 years ago|
|setup.py||1 year ago|
Packagers: Breathe packages on PyPI are PGP signed for Breathe >= v4.28.0.
Packagers: Breathe tarballs on GitHub are PGP signed for Breathe >= v4.29.0.
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
The source for the documentation is in the
documentation folder 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
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.
Development is currently done with:
- Python 3.5
- Docutils 0.12
- Sphinx 2.3.1
- Doxygen 1.8.4
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 Archives
The archive for the Google groups list can be found here.
Please post new questions as GitHub issues.
Examples of Breathe used by other projects:
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.
See the mkrelease utility in the root of the repository.
- Anthony Truchet
- Daniel Matz
- Andrew Hundt
- Many more, this list is rather outdated. Refer to the git history.
- Dimitri van Heesch for Doxygen.
- Georg Brandl for Sphinx.
- David Goodger for Docutils and reStructuredText.
See the CHANGELOG.rst