AsciiDoxy可以从Doxygen XML输出生成AsciiDoc格式的API文档。
项目描述
___ _ _ ____
/ | __________(_|_) __ \____ _ ____ __
/ /| | / ___/ ___/ / / / / / __ \| |/_/ / / /
/ ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ /
/_/ |_/____/\___/_/_/_____/\____/_/|_|\__, /
/____/
[ 主页 | 什么是AsciiDoxy? | 入门 | 参考文档 | 示例 | 贡献 | 变更日志 | GitHub ]
AsciiDoxy 允许您利用 AsciiDoc 和 Python 的结合力量生成精美的文档。使用 AsciiDoc 格式 编写文档，并使用 Python 代码 和 Mako 模板 生成额外内容。最后，插入由 Doxygen 生成的 API 文档以记录您的软件。
对于 API 文档，以下语言通过 Doxygen 支持
- C++
- Java
- Objective-C
- Python（使用 doxypypy）
- Swift（仅从 Objective-C 转码，预期在 0.9.x 中提供原生支持）
- Kotlin（仅从 Java 转码，预期在 0.9.x 中提供原生支持）
其他功能
- 从远程服务器收集 AsciiDoc 文件、图像、API 文档和其他资源。
- 生成单个 HTML 页面或多页分层结构。
- 转码：展示如何在另一种兼容语言中使用一种语言编写的元素。
现在就开始吧！
想尝试 AsciiDoxy 以及它支持的所有工具？使用我们的 Docker 镜像
docker run --rm -it silvester747/asciidoxy:latest asciidoxy --help
要开始编写精美的文档，您可以在我们的 入门指南 中找到所需的一切。
致谢
创建 AsciiDoxy 的灵感来源于 Sy Brand 的这篇文章：https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
在 GitHub 上公开发布之前，TomTom（https://www.tomtom.com）内部的多个人为 AsciiDoxy 的内部版本做出了贡献。向以下人员表示感谢：
- Andy Salter
- Arkadiusz Skalski
- Lukasz Glowcyk
- Nebojsa Mrmak
- Niels van der Schans
- Robert Gernert
- Tomasz Maj
python 包是用 Cookiecutter 和 audreyr/cookiecutter-pypackage 项目模板创建的。
下载文件
下载适用于您的平台文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源分布
asciidoxy-0.8.7.tar.gz (761.4 kB 查看哈希值)
构建分布
asciidoxy-0.8.7-py2.py3-none-any.whl (150.4 kB 查看哈希值)