Open Collective
Open Collective

Breathe

Your technical docs, beautifully integrated

Contribute


Become a financial contributor.

Financial Contributions

Recurring contribution
Backer

Become a backer for $5.00 per month and support us

Starts at$5 USD / month

Recurring contribution
Sponsor

Become a sponsor for $100.00 per month and support us

Starts at$100 USD / month

Custom contribution
Donation
Make a custom one-time or recurring contribution.

Breathe is all of us

Our contributors 3

Thank you for supporting Breathe.

About


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. 

The project works as a bridge between Doxygen's XML output and Sphinx's reStructuredText-based API. As a user, you run Doxygen in a manner configured to generated XML files and then you include Breathe-specific reStructuredText directives in your Sphinx documents that are used to reference data from the XML. When running your Sphinx build, the XML is read and processed into clean, clear, easy to read and well integrated technical documentation in your Sphinx build output. 

We are the organisation that supports and develops the Breathe project.

Our team