文档说明 1.2.0

使用方法

dookumentation.py file.py

dookumentation.py /path/to/folder/

插件使用

• 下载并将插件保存到 /doc/plugins/，就这么简单。

安装

PIP: (推荐！)

sudo pip3 install dookumentation

要求

• Python 3.x

输出格式

• HTML5，Material Design，压缩后的 *.html

• Markdown，GitHub 兼容，格式化的 *.md

• RST，ReStructuredText，格式化的 *.rst

• JSON，格式化的，JavaScript 兼容 *.json

• ODT，ODF ODT 文档，LibreOffice 兼容 *.odt

• 电子书，压缩后的带 HTML5 文档的电子书，ePub3 兼容，通过 --ebook 参数可选 *.epub

• ZIP，带 HTML5 文档的压缩 ZIP 文件，通过 --zip 参数可选 *.zip

• SVG 用于网页，HTML5 <svg> 独立文档，格式化的 *.svg

• XML，通用 XML，格式化的 *.xml

• TXT，未格式化的纯文本 *.txt

• 更多

输入格式

• *.py, *.pyw Python 源代码文件，单个文件或递归的整个文件夹。

独立异步单文件跨平台无依赖 Unicode Python3 多格式自动文档生成器。想象一下，我们将 Sphinx、PanDoc、Material Design、MkDocs、电子书、LibreOffice 文档、K.I.S.S. 原则混合在一起，然后去掉所有冗余，Dookumentation 就这么诞生了，享受“文档的黑暗面”吧！。