AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
Project description
___ _ _ ____
/ | __________(_|_) __ \____ _ ____ __
/ /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
/ ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ /
/_/ |_/____/\___/_/_/_____/\____/_/|_|\__, /
/____/
[ Home | What is AsciiDoxy? | Getting started | Reference documentation | Examples | Contributing | Changelog | GitHub ]
AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc. AsciiDoctor is then used to create HTML or PDF documentation that can be published online.
Supported languages:
- C++
- Java
- Objective-C
- Python (using doxypypy)
- Swift (transcoded from Objective-C only)
- Kotlin (transcoded from Java only)
Features:
- API documentation generation.
- Collecting API reference information from remote and local sources.
- Single and multipage HTML output.
- Single page PDF output.
- Transcoding: showing how to use elements written in one language in another compatible language.
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.8.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7500476ec2455b6f8504baab28ca488a48b266c1ab321ec52a86a3378e3cbd2d |
|
MD5 | 3a63b2ef15717997fb740c43d31d74d2 |
|
BLAKE2b-256 | 0e591cf2d004dcc363e89212aa0c42b886be4f8588e37e945404831e9724560b |