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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

Uploaded Python 3

File details

Details for the file alveolus-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: alveolus-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 135.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for alveolus-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d3e16a938cd7ad55f8f3f658d394937bbe786feb2f7a6fe5face629550cb8686
MD5 1cb2b16ccef5cdb53f9f19497d6cbaa2
BLAKE2b-256 1e7f6f22fabb453bd5f3fec2bd13d97dc291c9e30490190b8a9e7f7b842f44ae

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page