breathe

ReStructuredText and Sphinx bridge to Doxygen

https://github.com/breathe-doc/breathe

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
5 of 118 committers (4.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary

Keywords

doxygen sphinx

Keywords from Contributors

closember alignment flexible gtk qt tk wx conda package-management tensors

Last synced: 6 months ago · JSON representation

Repository

ReStructuredText and Sphinx bridge to Doxygen

Basic Info

Host: GitHub
Owner: breathe-doc
License: other
Language: Python
Default Branch: main
Homepage: https://breathe-doc.org
Size: 3.13 MB

Statistics

Stars: 786
Watchers: 18
Forks: 207
Open Issues: 197
Releases: 12

Topics

doxygen sphinx

Created about 17 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing Funding License

README.rst

.. image:: https://www.breathe-doc.org/img/logo.svg
:align: center
:alt: Breathe logo
:width: 200
:height: 200
:target: https://www.breathe-doc.org

Breathe
=======

**Your technical docs, beautifully integrated**

.. image:: https://github.com/breathe-doc/breathe/actions/workflows/unit_tests.yml/badge.svg
:target: https://github.com/breathe-doc/breathe/actions/workflows/unit_tests.yml
: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 `__.

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:

- `PyTorch `_
- `OpenPilot `_
- `XGBoost `_
- `NumPy `_
- `Mozilla's DeepSpeech `_
- `Microsoft's LightGBM `_
- `PyBind11 `_
- `Ceph `_
- `Apache Arrow `_
- `LVGL `_
- `Espressif IoT Development Framework `_
- `Zephyr Project `_
- `Plaid ML `_
- `Sony's Neural Network Libraries `_
- `fmt `_

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
`_

Owner

Name: Breathe
Login: breathe-doc
Kind: organization
Email: support@breathe-doc.org

Website: https://www.breathe-doc.org
Repositories: 1
Profile: https://github.com/breathe-doc

Your technical docs, beautifully integrated

GitHub Events

Total

Create event: 7
Release event: 2
Issues event: 18
Watch event: 31
Delete event: 8
Issue comment event: 95
Push event: 48
Pull request review comment event: 11
Pull request review event: 17
Pull request event: 32
Fork event: 10

Last Year

Create event: 7
Release event: 2
Issues event: 18
Watch event: 31
Delete event: 8
Issue comment event: 95
Push event: 48
Pull request review comment event: 11
Pull request review event: 17
Pull request event: 32
Fork event: 10

Committers

Last synced: 8 months ago

All Time

Total Commits: 1,467
Total Committers: 118
Avg Commits per committer: 12.432
Development Distribution Score (DDS): 0.692

Past Year

Commits: 65
Committers: 12
Avg Commits per committer: 5.417
Development Distribution Score (DDS): 0.446

Top Committers

Name	Email	Commits
Michael Jones	m**s@g**m	452
Melvin Vermeeren	m**l@m**n	201
Victor Zverovich	v**h@g**m	173
Jakob Lykke Andersen	J**b@c**k	172
Michael Jones	m**s@w**z	81
Fabio Utzig	f**g@n**o	40
2bndy5	2**5@g**m	38
Adam Turner	9****r	36
mpj	m**j@d**m	27
Andy Neebel	a**y@a**t	15
Rotzbua	R****a	12
Michael Jones	m**l@j**k	11
Dominik Böhi	d**i@g**m	8
Tatsuyuki Ishi	i**i@g**m	8
Richard Weickelt	r**d@w**e	7
Dan Čermák	d**k@c**m	7
Thomas Braun	t**n@b**e	6
Rémy Léone	r**e@g**m	6
Michal Čihař	m**l@c**m	6
Eric Wieser	w**c@g**m	6
Sylvain Corlay	s**y@g**m	5
Eric T. Johnson	y****3	5
michaelj	m**j@a**u	5
Marti Bolivar	m**r@l**m	5
Dean Moldovan	d**d@g**m	4
Gerard Marull-Paretas	g**l@n**o	4
Michel Hidalgo	m**l@e**m	4
Roger Barton	r**n@s**h	4
schaetz	s**z@s**)	3
Przemek Czerkas	p**s@g**m	3
and 88 more...

Committer Domains (Top 20 + Academic)

debian.org: 2 nordicsemi.no: 2 zoho.com: 1 rkapl.cz: 1 runtux.com: 1 mail.ru: 1 neonode.com: 1 mit.edu: 1 intel.com: 1 gnu.org: 1 garethrees.org: 1 duagon.com: 1 posteo.eu: 1 gonggri.jp: 1 lassosoft.com: 1 bmw.de: 1 schaetz-desktop.(none): 1 student.ethz.ch: 1 ekumenlabs.com: 1 leaflabs.com: 1 uw.edu: 1 cmu.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 140
Total pull requests: 102
Average time to close issues: 10 months
Average time to close pull requests: 4 months
Total issue authors: 106
Total pull request authors: 42
Average comments per issue: 3.0
Average comments per pull request: 2.82
Merged pull requests: 65
Bot issues: 0
Bot pull requests: 3

Past Year

Issues: 12
Pull requests: 40
Average time to close issues: 8 days
Average time to close pull requests: 11 days
Issue authors: 11
Pull request authors: 9
Average comments per issue: 0.83
Average comments per pull request: 1.28
Merged pull requests: 27
Bot issues: 0
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

cjdb (7)
Rotzbua (4)
ReenigneArcher (4)
kdschlosser (3)
iquah1 (3)
2bndy5 (3)
LecrisUT (3)
santiagopagani (2)
AA-Turner (2)
dylanh724 (2)
SigmaKlim (2)
michaeljones (2)
svenevs (2)
LudovicGuerra (2)
hwhsu1231 (2)

Pull Request Authors

Rotzbua (25)
yut23 (10)
michaeljones (9)
jakobandersen (7)
dependabot[bot] (4)
ReenigneArcher (4)
vermeeren (4)
Rouslan (3)
scottamain (3)
RaumZeit (3)
gareth-rees (3)
2bndy5 (2)
emilydolson (2)
v01dXYZ (2)
hojalot (2)

Top Labels

Issue Labels

enhancement (12) code (12) support (8) suggestion (6) upstream (4) duplicate (2) bug (2) test (1) regression (1) packaging (1)

Pull Request Labels

dependencies (4) packaging (3) github_actions (2) bug (2) upstream (2) regression (2) analysis (1)

Packages

Total packages: 3
Total downloads:
- pypi 868,443 last-month
Total docker downloads: 3,144,520

Total dependent packages: 44
(may contain duplicates)
Total dependent repositories: 5,995
(may contain duplicates)
Total versions: 172
Total maintainers: 5

pypi.org: breathe

Sphinx Doxygen renderer

Homepage: https://www.breathe-doc.org/
Documentation: https://breathe.readthedocs.io/
License: BSD License
Latest release: 4.36.0
published 12 months ago

Versions: 68
Dependent Packages: 42
Dependent Repositories: 5,684
Downloads: 868,443 Last month
Docker Downloads: 3,144,520

Rankings

Dependent repos count: 0.1%

Dependent packages count: 0.3%

Downloads: 0.6%

Docker downloads count: 0.7%

Average: 1.3%

Stargazers count: 2.4%

Forks count: 3.7%

Maintainers (5)

JohanMabille Sylvain.Corlay vitaut melvinvermeeren Michael.Jones

Last synced: 6 months ago

proxy.golang.org: github.com/breathe-doc/breathe

Documentation: https://pkg.go.dev/github.com/breathe-doc/breathe#section-documentation
License: other
Latest release: v4.36.0+incompatible
published 12 months ago

Versions: 63
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Forks count: 2.0%

Stargazers count: 2.3%

Average: 6.2%

Dependent packages count: 9.6%

Dependent repos count: 10.8%

Last synced: 6 months ago

conda-forge.org: breathe

Breathe provides a bridge between the Sphinx and Doxygen documentation systems. It is an easy way to include Doxygen information in a set of documentation generated by Sphinx. The aim is to produce an autodoc like support for people who enjoy using Sphinx but work with languages other than Python. The system relies on the Doxygen’s xml output.

Homepage: https://github.com/breathe-doc/breathe
License: BSD-3-Clause
Latest release: 4.34.0
published over 3 years ago

Versions: 41
Dependent Packages: 2
Dependent Repositories: 311

Rankings

Dependent repos count: 1.8%

Average: 12.7%

Forks count: 13.7%

Stargazers count: 15.9%

Dependent packages count: 19.6%

Last synced: 6 months ago

Dependencies

requirements/development.txt pypi

black ==22.3.0
flake8 *
furo *
mypy >=0.900
pip-tools >=0.3.5
pytest *
sphinx-copybutton *
types-Pygments *
types-docutils >=0.14,<0.18

requirements/production.txt pypi

Jinja2 >=2.7.3
MarkupSafe >=0.23
Pygments >=1.6
Sphinx >=4.0,<6,
docutils >=0.12

.github/workflows/documentation.yml actions

actions/cache v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite
actions/upload-artifact v2 composite

.github/workflows/lint.yml actions

actions/cache v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite

.github/workflows/unit_tests.yml actions

actions/cache v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite

breathe/directives/setup.py pypi

pyproject.toml pypi

setup.py pypi

documentation/environment.yaml pypi