Skip to main content

Alveolus Docs,provides a very simple way, to create read the docs alike documentation for c++ projects.With the help of breathe and exhale it combines Doxygen and sphinx to enable tou to createcode documentation as well as custom documentation files

Project description

Alveolus Documentation Package

Alveolus is a small package that makes your C++ Documentation process easier. Using Breathe and Exhale you can combine your C++ Code Documentation with your Custom API doxumentation written in simple .rst files . This projects relies heavily on Doxygen+Sphinx+Breathe+Exhale but makes the process of combining them nad using them easier. Run alveolus-build in any c++ project and an index html with the ReadTheDocs theme will be created instantly

Using Alveolus

There are 4 commands added to your path

  • alveolus-build
  • alveolus-create
  • alveolus-clean
  • alveolus-cli

Installation Instructions

Dependencies

Credit

License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

alveolus-0.1.2-py3-none-any.whl (135.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page