python-breathe
Port variant v12
Summary Sphinx Doxygen renderer (3.12)
Package version 4.36.0
Homepage https://www.breathe-doc.org/
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v13
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 28 FEB 2025, 23:01:01 UTC
Port created 15 APR 2020, 16:28:14 UTC
Subpackage Descriptions
single Breathe ======= **Your technical docs, beautifully integrated** :alt: Build Status Website_ • Documentation_ • Sponsor_ **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]. .. _Website: https://www.breathe-doc.org/ .. _Documentation: https://breathe.readthedocs.io/en/latest/ .. _Sponsor: https://opencollective.com/breathe ---- 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].
Configuration Switches (platform-specific settings discarded)
PY312 ON Build using Python 3.12 PY313 OFF Build using Python 3.13
Package Dependencies by Type
Build (only) python312:dev:std
python-pip:single:v12
autoselect-python:single:std
Build and Runtime python312:primary:std
Runtime (only) python-Sphinx:single:v12
Download groups
main mirror://PYPIWHL/2c/bc/d67ef1e11ed6e6343c135bf605aa9d5734ff0cc77eb42a2a41f182abc9d9
Distribution File Information
af85436f1f09e842bd1fd95617281211c635f8768d245ff830c59b979888d1d5 97231 python-src/breathe-4.36.0-py3-none-any.whl
Ports that require python-breathe:v12
libtcod:std Roguelike game development library
python-exhale:v12 C++ library API documentation generator (3.12)