| Name | breathe JSON |
| Version |
4.36.0
JSON |
| download |
| home_page | None |
| Summary | Sphinx Doxygen renderer |
| upload_time | 2025-02-22 18:36:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. 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 <https://opencollective.com/breathe>`_.
.. _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
<https://pypi.org/project/breathe/>`_. It can be installed with::
pip install breathe
Documentation
-------------
The documentation is available `here <https://breathe.readthedocs.io/>`__. Thank
you to the people running `Read the Docs <https://readthedocs.org>`_ 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 <https://groups.google.com/forum/#!forum/sphinx-breathe>`__.
The previous mailing list was on `librelist.com <https://librelist.com>`__ and the
archives are available `here <https://librelist.com/browser/breathe/>`__.
Please post new questions as GitHub issues.
Projects Using Breathe
----------------------
Examples of projects that use Breathe:
- `PyTorch <https://github.com/pytorch/pytorch>`_
- `OpenPilot <https://github.com/commaai/openpilot>`_
- `XGBoost <https://github.com/dmlc/xgboost>`_
- `NumPy <https://github.com/numpy/numpy>`_
- `Mozilla's DeepSpeech <https://github.com/mozilla/DeepSpeech>`_
- `Microsoft's LightGBM <https://github.com/microsoft/LightGBM>`_
- `PyBind11 <https://github.com/pybind/pybind11>`_
- `Ceph <https://github.com/ceph/ceph>`_
- `Apache Arrow <https://github.com/apache/arrow>`_
- `LVGL <https://github.com/lvgl/lvgl>`_
- `Espressif IoT Development Framework <https://github.com/espressif/esp-idf>`_
- `Zephyr Project <https://github.com/zephyrproject-rtos/zephyr>`_
- `Plaid ML <https://github.com/plaidml/plaidml>`_
- `Sony's Neural Network Libraries <https://github.com/sony/nnabla>`_
- `fmt <https://fmt.dev/latest/>`_
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 <https://github.com/vermeeren>`_ & `jakobandersen <https://github.com/jakobandersen>`_
and was formerly maintained by `michaeljones <https://github.com/michaeljones>`_
& `vitaut <https://github.com/vitaut>`_.
See `CONTRIBUTORS </CONTRIBUTORS.rst>`_ for the full list.
Acknowledgements
----------------
- Dimitri van Heesch for `Doxygen <https://www.doxygen.nl/>`_.
- Georg Brandl for `Sphinx <https://www.sphinx-doc.org/>`_.
- David Goodger for `Docutils <https://docutils.sourceforge.io/>`_ and reStructuredText.
Changelog
---------
See the `CHANGELOG.rst
<https://github.com/breathe-doc/breathe/blob/master/CHANGELOG.rst>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "breathe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Michael Jones <m.pricejones@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/56/99bf7d0799d95ad485d95596dc01c2a5b3dda58ebf50a94f6f73b33bacdf/breathe-4.36.0.tar.gz",
"platform": null,
"description": ".. image:: https://www.breathe-doc.org/img/logo.svg\n :align: center\n :alt: Breathe logo\n :width: 200\n :height: 200\n :target: https://www.breathe-doc.org\n\nBreathe\n=======\n\n**Your technical docs, beautifully integrated**\n\n.. image:: https://github.com/breathe-doc/breathe/actions/workflows/unit_tests.yml/badge.svg\n :target: https://github.com/breathe-doc/breathe/actions/workflows/unit_tests.yml\n :alt: Build Status\n\nWebsite_ \u2022 Documentation_ \u2022 Sponsor_\n\n**Sponsor**: If you benefit from using Breathe as a company or an individual, you\ncan financially support the Breathe project with recurring or one off\ncontributions via `Open Collective <https://opencollective.com/breathe>`_.\n\n.. _Website: https://www.breathe-doc.org/\n.. _Documentation: https://breathe.readthedocs.io/en/latest/\n.. _Sponsor: https://opencollective.com/breathe\n\n----\n\nBreathe is a Sphinx plugin providing beautifully integrated Doxygen output in\nyour user-facing documentation. It allows you to combine Doxygen's excellent\ntechnical understanding of your code base with the superb long form\ndocumentation output of the Sphinx system.\n\nFor Packagers\n-------------\n\n- Breathe packages on PyPI are PGP signed for Breathe >= v4.28.0.\n- Breathe tarballs on GitHub are PGP signed for Breathe >= v4.29.0.\n\nDownload\n--------\n\nBreathe is available from github and `PyPI, the Python Package Index\n<https://pypi.org/project/breathe/>`_. It can be installed with::\n\n pip install breathe\n\nDocumentation\n-------------\n\nThe documentation is available `here <https://breathe.readthedocs.io/>`__. Thank\nyou to the people running `Read the Docs <https://readthedocs.org>`_ for such an\nexcellent service.\n\nThe source for the documentation is in the ``documentation`` folder if you want\nto built it and read it locally.\n\nTesting\n-------\n\nThe testsuite can be run with::\n\n make dev-test\n\nThe documentation also does a good effort of covering the available\nfunctionality with different examples. To build the documentation, run::\n\n make\n\nThis will run doxygen over the example code and then run the Breathe\ndocumentation. View the results at::\n\n documentation/build/html/index.html\n\nFurther to this if you want to compare the current documentation output against\na previous state in order to check for regressions there is a ``compare`` script\nin the ``documentation`` folder. It takes two arguments which are two commit\nreferences that you'd like to compare. This means that all your changes have to\nbe committed first. Also the script does not resolve state dependent references\nlike ``HEAD`` so provide concrete commit references like sha1s or branch names.\nA typical example is to compare your current branch output to master::\n\n # Make sure all your changes are committed first\n cd documentation\n ./compare master my-branch\n\nThis will do a checkout and build at each commit and then run ``meld`` against\nthe resulting directories so you can see the differences introduced by your\nbranch.\n\nRequirements\n------------\n\nBreathe requires Python 3.9+, Sphinx 7.2+, and Doxygen 1.9.2+.\n\nMailing List Archives\n---------------------\n\nThe archive for the Google groups list can be found\n`here <https://groups.google.com/forum/#!forum/sphinx-breathe>`__.\n\nThe previous mailing list was on `librelist.com <https://librelist.com>`__ and the\narchives are available `here <https://librelist.com/browser/breathe/>`__.\n\nPlease post new questions as GitHub issues.\n\nProjects Using Breathe\n----------------------\n\nExamples of projects that use Breathe:\n\n- `PyTorch <https://github.com/pytorch/pytorch>`_\n- `OpenPilot <https://github.com/commaai/openpilot>`_\n- `XGBoost <https://github.com/dmlc/xgboost>`_\n- `NumPy <https://github.com/numpy/numpy>`_\n- `Mozilla's DeepSpeech <https://github.com/mozilla/DeepSpeech>`_\n- `Microsoft's LightGBM <https://github.com/microsoft/LightGBM>`_\n- `PyBind11 <https://github.com/pybind/pybind11>`_\n- `Ceph <https://github.com/ceph/ceph>`_\n- `Apache Arrow <https://github.com/apache/arrow>`_\n- `LVGL <https://github.com/lvgl/lvgl>`_\n- `Espressif IoT Development Framework <https://github.com/espressif/esp-idf>`_\n- `Zephyr Project <https://github.com/zephyrproject-rtos/zephyr>`_\n- `Plaid ML <https://github.com/plaidml/plaidml>`_\n- `Sony's Neural Network Libraries <https://github.com/sony/nnabla>`_\n- `fmt <https://fmt.dev/latest/>`_\n\nRelease\n-------\n\n1. Update `CHANGELOG.rst` and create the git tag (`vX.Y.Z`).\n2. Push the tag to GitHub.\n3. The `create-release.yml` workflow will publish the release to PyPI.\n4. Go to https://github.com/breathe-doc/breathe/tags, select the new tag,\n and click the \"Create release from tag\" button to publish a GitHub release.\n\nMaintainers\n-----------\n\nBreathe is currently maintained by `vermeeren <https://github.com/vermeeren>`_ & `jakobandersen <https://github.com/jakobandersen>`_\nand was formerly maintained by `michaeljones <https://github.com/michaeljones>`_\n& `vitaut <https://github.com/vitaut>`_.\n\nSee `CONTRIBUTORS </CONTRIBUTORS.rst>`_ for the full list.\n\nAcknowledgements\n----------------\n\n- Dimitri van Heesch for `Doxygen <https://www.doxygen.nl/>`_.\n- Georg Brandl for `Sphinx <https://www.sphinx-doc.org/>`_.\n- David Goodger for `Docutils <https://docutils.sourceforge.io/>`_ and reStructuredText.\n\nChangelog\n---------\n\nSee the `CHANGELOG.rst\n<https://github.com/breathe-doc/breathe/blob/master/CHANGELOG.rst>`_\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx Doxygen renderer",
"version": "4.36.0",
"project_urls": {
"Changelog": "https://github.com/breathe-doc/breathe/blob/main/CHANGELOG.rst",
"Code": "https://github.com/breathe-doc/breathe/",
"Documentation": "https://breathe.readthedocs.io/",
"Download": "https://pypi.org/project/breathe/",
"Homepage": "https://www.breathe-doc.org/",
"Issue tracker": "https://github.com/breathe-doc/breathe/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2cbcd67ef1e11ed6e6343c135bf605aa9d5734ff0cc77eb42a2a41f182abc9d9",
"md5": "051d733bb7ad60d6bc1106099e3ea9f6",
"sha256": "af85436f1f09e842bd1fd95617281211c635f8768d245ff830c59b979888d1d5"
},
"downloads": -1,
"filename": "breathe-4.36.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "051d733bb7ad60d6bc1106099e3ea9f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 97231,
"upload_time": "2025-02-22T18:36:01",
"upload_time_iso_8601": "2025-02-22T18:36:01.087357Z",
"url": "https://files.pythonhosted.org/packages/2c/bc/d67ef1e11ed6e6343c135bf605aa9d5734ff0cc77eb42a2a41f182abc9d9/breathe-4.36.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "015699bf7d0799d95ad485d95596dc01c2a5b3dda58ebf50a94f6f73b33bacdf",
"md5": "a263b4f3869ae2e7c4e60b5cdc8620da",
"sha256": "14860b73118ac140b7a3f55446890c777d1b67149cb024279fe3710dad7f535c"
},
"downloads": -1,
"filename": "breathe-4.36.0.tar.gz",
"has_sig": false,
"md5_digest": "a263b4f3869ae2e7c4e60b5cdc8620da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 154842,
"upload_time": "2025-02-22T18:36:03",
"upload_time_iso_8601": "2025-02-22T18:36:03.360097Z",
"url": "https://files.pythonhosted.org/packages/01/56/99bf7d0799d95ad485d95596dc01c2a5b3dda58ebf50a94f6f73b33bacdf/breathe-4.36.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-22 18:36:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "breathe-doc",
"github_project": "breathe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "breathe"
}
