{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Exhale automatically generates C++ API documentation by running Doxygen, parsing its XML output with BeautifulSoup and lxml, and publishing class, file, and page hierarchies as reStructuredText documents within Sphinx.","skillfed_tags":["c++-documentation","doxygen-integration","sphinx-extension"],"use_cases":["Generate browsable C++ API docs with Sphinx styling and Doxygen's class/file hierarchies for a medium-sized library.","Maintain automatically synchronized API documentation that regenerates whenever source code changes.","Publish C++ reference docs alongside prose documentation in a unified Sphinx site.","Create tree-view navigation of C++ classes and files in RTD Theme or Bootstrap Theme Sphinx sites.","Avoid manual synchronization between Doxygen and Sphinx by automating the full pipeline."],"what_it_does":"Exhale is a Sphinx extension that bridges Doxygen and Sphinx by automatically running Doxygen on your C++ source, parsing the generated XML with BeautifulSoup and lxml, and reconstructing Doxygen's class, file, and page hierarchies as reStructuredText documents. This allows you to publish C++ API documentation with Sphinx's styling and navigation while preserving the structural organization that Doxygen provides\u2014something Breathe alone does not offer.\n\nThe package is designed for projects that want beautiful Sphinx-generated websites but also value Doxygen's hierarchical organization. It regenerates documentation on every build, keeping it automatically in sync with code changes. However, it requires more setup machinery than simpler alternatives like Breathe's autodoxygenindex directive or breathe-apidoc, and the documentation notes it works well on small-to-medium projects; larger projects may face performance or complexity challenges due to the large number of .rst files Exhale generates.","worth_installing":"Yes, if you need C++ API documentation with Doxygen's hierarchies in Sphinx and your project is small to medium-sized. The low install friction, permissive license, and zero known vulnerabilities make it safe to try. However, dormant maintenance (last release 2024-01-21) and the documented limitation to small-to-medium projects are real constraints\u2014verify compatibility with your Sphinx/Breathe versions and test on a realistic project before committing to it for large codebases."},"id":"exhale","links":{"html":"https://skillfed.io/packages/exhale","md":"https://skillfed.io/packages/exhale.md","pypi":"https://pypi.org/project/exhale/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-01-21","license_spdx":null,"license_treatment":"permissive","name":"exhale","python_support":"supports_current","summary":"Automatic C++ library API documentation generator using Doxygen, Sphinx, and"},"popularity":{"monthly_downloads":317471,"position":7661,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.3.7"}