asciidoxy 0.8.7
AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
License: Apache 2.0
Keywords: asciidoxy,asciidoc,doxygen,documentation

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

[ [Home](https://asciidoxy.org) |
[What is AsciiDoxy?](https://asciidoxy.org/about.html) |
[Getting started](https://asciidoxy.org/getting-started.html) |
[Reference documentation](https://asciidoxy.org/reference.html) |
[Examples](https://asciidoxy.org/examples.html) |
[Contributing](https://asciidoxy.org/contributing.html) |
[Changelog](CHANGELOG.adoc) |
[GitHub](https://github.com/tomtom-international/asciidoxy) ]

[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](LICENSE)
[![pip downloads](https://img.shields.io/pypi/dm/asciidoxy)](https://pypi.org/project/asciidoxy)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/asciidoxy)](https://pypi.org/project/asciidoxy)
[![PyPI](https://img.shields.io/pypi/v/asciidoxy)](https://pypi.org/project/asciidoxy)

AsciiDoxy let's you generate beautiful documentation using the combined power of AsciiDoc and 
Python. Write your documentation in [AsciiDoc 
format](https://docs.asciidoctor.org/asciidoc/latest/)
and use [Python code](https://python.org) and [Mako Templates](https://makotemplates.org) to 
generate additional content. To top it all off, insert API documentation generated by 
[Doxygen](https://doxygen.nl) to document your software.

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

- C++
- Java
- Objective-C
- Python (using [doxypypy](https://github.com/Feneric/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:

```bash
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](https://asciidoxy.org/getting-started.html).


## 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](https://www.tomtom.com) 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](https://github.com/audreyr/cookiecutter) and the
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.