```
___ _ _ ____
/ | __________(_|_) __ \____ _ ____ __
/ /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
/ ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ /
/_/ |_/____/\___/_/_/_____/\____/_/|_|\__, /
/____/
```
[ [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://pypi.org/project/asciidoxy)
[](https://pypi.org/project/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.
Raw data
{
"_id": null,
"home_page": "https://asciidoxy.org",
"name": "asciidoxy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "asciidoxy,asciidoc,doxygen,documentation",
"author": "Rob van der Most",
"author_email": "Rob.vanderMost@TomTom.com",
"download_url": "https://files.pythonhosted.org/packages/9c/c1/14ee24052d9a3558b5fcbac1ae5be7810f70376d7930ba15809a77c3511c/asciidoxy-0.8.7.tar.gz",
"platform": null,
"description": "```\n ___ _ _ ____\n / | __________(_|_) __ \\____ _ ____ __\n / /| | / ___/ ___/ / / / / / __ \\| |/_/ / / /\n / ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ /\n/_/ |_/____/\\___/_/_/_____/\\____/_/|_|\\__, /\n /____/\n```\n\n[ [Home](https://asciidoxy.org) |\n[What is AsciiDoxy?](https://asciidoxy.org/about.html) |\n[Getting started](https://asciidoxy.org/getting-started.html) |\n[Reference documentation](https://asciidoxy.org/reference.html) |\n[Examples](https://asciidoxy.org/examples.html) |\n[Contributing](https://asciidoxy.org/contributing.html) |\n[Changelog](CHANGELOG.adoc) |\n[GitHub](https://github.com/tomtom-international/asciidoxy) ]\n\n[](LICENSE)\n[](https://pypi.org/project/asciidoxy)\n[](https://pypi.org/project/asciidoxy)\n[](https://pypi.org/project/asciidoxy)\n\nAsciiDoxy let's you generate beautiful documentation using the combined power of AsciiDoc and \nPython. Write your documentation in [AsciiDoc \nformat](https://docs.asciidoctor.org/asciidoc/latest/)\nand use [Python code](https://python.org) and [Mako Templates](https://makotemplates.org) to \ngenerate additional content. To top it all off, insert API documentation generated by \n[Doxygen](https://doxygen.nl) to document your software.\n\nFor API documentation, the following languages are currently supported through Doxygen:\n\n- C++\n- Java\n- Objective-C\n- Python (using [doxypypy](https://github.com/Feneric/doxypypy))\n- Swift (transcoded from Objective-C only, native support expected in 0.9.x)\n- Kotlin (transcoded from Java only, native support expected in 0.9.x)\n\nOther features:\n\n- Collect AsciiDoc files, images, API documentation and other resources from remote servers.\n- Generate either a single HTML page or a multipage hierarchy.\n- Transcoding: showing how to use elements written in one language in another compatible language.\n\n\n## Get started now!\n\nWant to try out AsciiDoxy together with all the tools it supports? Use our Docker image:\n\n```bash\ndocker run --rm -it silvester747/asciidoxy:latest asciidoxy --help\n```\n\nAll you need to get started writing beautiful documentation can be found in our\n[getting started guide](https://asciidoxy.org/getting-started.html).\n\n\n## Credits\n\nInspiration for creating AsciiDoxy was found in this article by Sy Brand:\nhttps://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/\n\nBefore going public on GitHub, several people inside [TomTom](https://www.tomtom.com) contributed to\nthe internal version of AsciiDoxy. Many thanks to:\n\n- Andy Salter\n- Arkadiusz Skalski\n- Lukasz Glowcyk\n- Nebojsa Mrmak\n- Niels van der Schans\n- Robert Gernert\n- Tomasz Maj\n\nThe python package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the\n[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.",
"version": "0.8.7",
"project_urls": {
"Bug Tracker": "https://github.com/tomtom-international/asciidoxy/issues",
"Documentation": "https://asciidoxy.org",
"Homepage": "https://asciidoxy.org",
"Source Code": "https://github.com/tomtom-international/asciidoxy"
},
"split_keywords": [
"asciidoxy",
"asciidoc",
"doxygen",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe11153d0b2b11c985a800f47216b5eefebd56a188f72fc4aa82d3968bc680c5",
"md5": "7a5546ba222bcdcff8e820d27226bcd8",
"sha256": "722007a878e24fcbf8b1f1f747ea33c7a3bf13f1ab94a356f83cd8477e538831"
},
"downloads": -1,
"filename": "asciidoxy-0.8.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a5546ba222bcdcff8e820d27226bcd8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 150368,
"upload_time": "2023-09-10T15:33:31",
"upload_time_iso_8601": "2023-09-10T15:33:31.363882Z",
"url": "https://files.pythonhosted.org/packages/fe/11/153d0b2b11c985a800f47216b5eefebd56a188f72fc4aa82d3968bc680c5/asciidoxy-0.8.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9cc114ee24052d9a3558b5fcbac1ae5be7810f70376d7930ba15809a77c3511c",
"md5": "7a247e5710fd891cbbc03039d9b8a957",
"sha256": "194d1a62ab6a30c087dafbfd86ac2d8c209c453daa8d2064be2443d35db53c4e"
},
"downloads": -1,
"filename": "asciidoxy-0.8.7.tar.gz",
"has_sig": false,
"md5_digest": "7a247e5710fd891cbbc03039d9b8a957",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 761354,
"upload_time": "2023-09-10T15:33:33",
"upload_time_iso_8601": "2023-09-10T15:33:33.404744Z",
"url": "https://files.pythonhosted.org/packages/9c/c1/14ee24052d9a3558b5fcbac1ae5be7810f70376d7930ba15809a77c3511c/asciidoxy-0.8.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-10 15:33:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tomtom-international",
"github_project": "asciidoxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "asciidoxy"
}
JSON
