{"categories":[{"label":"Software Development","url":"https://skillfed.io/packages/category/software-development/5"},{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/3"},{"label":"Text Processing","url":"https://skillfed.io/packages/category/text-processing/2"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Breathe is a Sphinx plugin that renders Doxygen-generated documentation into your Sphinx documentation build, letting you embed API reference material from C/C++ code directly into user-facing docs.","skillfed_tags":["doxygen-integration","c-cpp-docs"],"use_cases":["Document a C/C++ library's public API alongside Python bindings or usage examples in a single Sphinx site.","Maintain API reference for a compiled extension module without manually writing or updating signatures.","Build unified docs for a polyglot project where some components are C/C++ and others are Python.","Embed live Doxygen output in a ReadTheDocs or similar hosted documentation site.","Generate searchable, cross-referenced API docs that stay in sync with source code changes."],"what_it_does":"Breathe bridges Doxygen and Sphinx, two widely used but separate documentation tools. Doxygen parses C/C++ source code and generates detailed API reference material; Sphinx builds polished, long-form documentation in HTML, PDF, and other formats. Breathe lets you combine them by reading Doxygen's XML output and rendering it as reStructuredText directives inside your Sphinx build, so your API docs live alongside your user guides, tutorials, and conceptual material in a single coherent documentation site.\n\nYou run Doxygen once on your codebase to generate XML, configure Breathe to point to that XML, then use Breathe directives in your .rst files to pull in function signatures, class hierarchies, and parameter documentation. It's widely used in mature projects\u2014PyTorch, NumPy, XGBoost, and others rely on it\u2014and requires Python 3.9+, Sphinx 7.2+, and Doxygen 1.9.2+.","worth_installing":"Yes, if you have C/C++ code to document alongside Sphinx-based docs and are willing to run Doxygen as a prerequisite. It is stable, permissively licensed, and proven in production by major projects. The aging maintenance status (538 days since release) is a minor concern but not a blocker\u2014the codebase is mature and the repository remains active. Install it if your documentation workflow already includes Doxygen; skip it if you're looking for pure Python API documentation."},"id":"breathe","links":{"html":"https://skillfed.io/packages/breathe","md":"https://skillfed.io/packages/breathe.md","pypi":"https://pypi.org/project/breathe/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-02-22","license_spdx":null,"license_treatment":"permissive","name":"breathe","python_support":"supports_current","summary":"Sphinx Doxygen renderer"},"popularity":{"monthly_downloads":1538211,"position":3791,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"4.36.0"}