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.
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
File details
Details for the file asciidoxy-0.8.5.tar.gz.
File metadata
- Download URL: asciidoxy-0.8.5.tar.gz
- Upload date:
- Size: 755.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 400310c7eaef85d115b1f833d4739d64c2c8adef013d0bc24e63f84993c5b600 |
|
| MD5 | af374af88a017294a9ecf67e0f59864a |
|
| BLAKE2b-256 | 1be8187c44bc314962c75991be97895ca57ee6561c8582d0ef47f06416be82f1 |
File details
Details for the file asciidoxy-0.8.5-py2.py3-none-any.whl.
File metadata
- Download URL: asciidoxy-0.8.5-py2.py3-none-any.whl
- Upload date:
- Size: 148.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed71cbf2d167622354c6b5e05d0291126b6c80abd5eac30112a519375cd826bb |
|
| MD5 | a5e4b1ce4f2c6daa4944b1a656c6d010 |
|
| BLAKE2b-256 | 3bcc125f4c7c1b4b4d658e357198b4ceaf6f10f99059d1c7c309e01209561a9e |
