Exhale

Automatic C++ library api documentation generation: breathe doxygen in and exhale it out. A Quickstart guide gives the bare minimum needed to get things working, please read the Overview section if you are new to Sphinx or Breathe.

This project revives the Doxygen style hierarchies in reStructuredText documents so that you can keep using the beautiful Sphinx websites, but have a more human-readable Library API without having to manually write it out yourself. Exhale is self-contained and easily portable to Read the Docs. You should be able to use any Sphinx theme of your choosing, though some of them likely work better than others.

A more comprehensive example repository (which was used for testing once upon a time) is located at the companion site.

• Overview
  • What does it do?
  • What does it need to do that?
• Usage
  • Quickstart
  • Additional Usage and Customization
  • Fully Automated Building
  • Doxygen Documentation Specifics
  • Start to finish for Read the Docs
• Developer Reference Documentation
  • Primary Entry Point
  • Helper Functions
  • Exposed Utility Variables
  • Ownership Graph Representation
• FAQ
  • Nothing is working, where did I go wrong?
  • Why does it build locally, but not on Read the Docs?
  • Metaprogramming and full template specialization?

Indices and tables

• Index
• Module Index
• Search Page