asciidoxy

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

[ Home | What is AsciiDoxy? | Getting started | Reference documentation | Examples | Contributing | Changelog | GitHub ]

AsciiDoxy let's you generate beautiful documentation using the combined power of AsciiDoc and Python. Write your documentation in AsciiDoc format and use Python code and Mako Templates to generate additional content. To top it all off, insert API documentation generated by Doxygen to document your software.

For API documentation, the following languages are currently supported through Doxygen:

• C++
• Java
• Objective-C
• Python (using doxypypy)
• Swift (transcoded from Objective-C only, native support expected in 0.9.x)
• Kotlin (transcoded from Java only, native support expected in 0.9.x)

Other features:

• Collect AsciiDoc files, images, API documentation and other resources from remote servers.
• Generate either a single HTML page or a multipage hierarchy.
• Transcoding: showing how to use elements written in one language in another compatible language.

Get started now!

Want to try out AsciiDoxy together with all the tools it supports? Use our Docker image:

docker run --rm -it silvester747/asciidoxy:latest asciidoxy --help

All you need to get started writing beautiful documentation can be found in our getting started guide.

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.