___              _ _ ____
   /   |  __________(_|_) __ \____  _  ____  __
  / /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
 / ___ |(__  ) /__/ / / /_/ / /_/ />  </ /_/ /
/_/  |_/____/\___/_/_/_____/\____/_/|_|\__, /
                                      /____/

AsciiDoxy

License pip downloads PyPI - Python Version PyPI

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.

AsciiDoxy