AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
Project description
___ _ _ ____
/ | __________(_|_) __ \____ _ ____ __
/ /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
/ ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ /
/_/ |_/____/\___/_/_/_____/\____/_/|_|\__, /
/____/
[ Home | What is AsciiDoxy? | Usage | Examples | Contributing | Changelog | GitHub ]
AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
Supported languages:
- C++
- Java
- Objective C
- Python (using doxypypy)
Features:
- API documentation generation.
- Collecting API reference information from remote and local sources.
- Single and multi page HTML output.
- Single page PDF output.
Credits
Inspiration for creating AsciiDoxy was found in this article by Sy Brand: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
Before going public on GitHub, several people inside TomTom contributed to the internal version of AsciiDoxy. Many thanks to:
- Andy Salter
- Arkadiusz Skalski
- Lukasz Glowcyk
- Nebojsa Mrmak
- Niels van der Schans
- Robert Gernert
- Tomasz Maj
The python package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for asciidoxy-0.5.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8320b5a7f2cb4a9aa84302519afb1286cce3a9a2f892ba6979295f84bc34aa66 |
|
MD5 | 6f30c0b342adca64a9b72dc010089e0d |
|
BLAKE2b-256 | 4238be7c0f2d6d15485af638fef425a54cb7a2555eafe9d663ff22e8bd44d9be |