Skip to main content

Sphinx Doxygen renderer

Project description

Breathe logo

Breathe

Your technical docs, beautifully integrated

Build Status

WebsiteDocumentationSponsor

Sponsor: If you benefit from using Breathe as a company or an individual, you can financially support the Breathe project with recurring or one off contributions via Open Collective.


Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your user-facing documentation. It allows you to combine Doxygen’s excellent technical understanding of your code base with the superb long form documentation output of the Sphinx system.

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

Download

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

pip install breathe

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.9+, Sphinx 7.2+, and Doxygen 1.9.2+.

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.

Projects Using Breathe

Examples of projects that use Breathe:

Release

  1. Update CHANGELOG.rst and create the git tag (vX.Y.Z).

  2. Push the tag to GitHub.

  3. The create-release.yml workflow will publish the release to PyPI.

  4. Go to https://github.com/breathe-doc/breathe/tags, select the new tag, and click the “Create release from tag” button to publish a GitHub release.

Maintainers

Breathe is currently maintained by vermeeren & jakobandersen and was formerly maintained by michaeljones & vitaut.

See CONTRIBUTORS for the full list.

Acknowledgements

  • Dimitri van Heesch for Doxygen.

  • Georg Brandl for Sphinx.

  • David Goodger for Docutils and reStructuredText.

Changelog

See the CHANGELOG.rst

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

breathe-4.36.0.tar.gz (154.8 kB view details)

Uploaded Source

Built Distribution

breathe-4.36.0-py3-none-any.whl (97.2 kB view details)

Uploaded Python 3

File details

Details for the file breathe-4.36.0.tar.gz.

File metadata

  • Download URL: breathe-4.36.0.tar.gz
  • Upload date:
  • Size: 154.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for breathe-4.36.0.tar.gz
Algorithm Hash digest
SHA256 14860b73118ac140b7a3f55446890c777d1b67149cb024279fe3710dad7f535c
MD5 a263b4f3869ae2e7c4e60b5cdc8620da
BLAKE2b-256 015699bf7d0799d95ad485d95596dc01c2a5b3dda58ebf50a94f6f73b33bacdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for breathe-4.36.0.tar.gz:

Publisher: create-release.yml on breathe-doc/breathe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file breathe-4.36.0-py3-none-any.whl.

File metadata

  • Download URL: breathe-4.36.0-py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for breathe-4.36.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af85436f1f09e842bd1fd95617281211c635f8768d245ff830c59b979888d1d5
MD5 051d733bb7ad60d6bc1106099e3ea9f6
BLAKE2b-256 2cbcd67ef1e11ed6e6343c135bf605aa9d5734ff0cc77eb42a2a41f182abc9d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for breathe-4.36.0-py3-none-any.whl:

Publisher: create-release.yml on breathe-doc/breathe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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