独立异步单文件跨平台无依赖Unicode Python3多格式自动文档生成器。假设我们将Sphinx、Pandoc、Material Design、Mkdocs、电子书、Libreoffice docs、K.I.S.S.原理混合在一起,去掉所有的臃肿,然后诞生Dookmentation,享受“黑暗”文件的一面!。
dookumentation的Python项目详细描述
用法:
dookumentation.py file.py dookumentation.py /path/to/folder/
插件使用:
- 下载插件并保存到/doc/plugins/,仅此而已。
安装
pip:(推荐!)
sudo pip3 install dookumentation
必要条件:
输出格式
- html5,材料设计,小型化*.html
- markdown,github兼容,打印精美*.md
- rst,重新构造文本,打印精美*.rst
- json,打印精美,与javascript兼容*.json
- odt,odf odt文档,libreoffice兼容*.odt
- 电子书,带有HTML5文档的压缩电子书,EPUB3 兼容,可选通过--ebook参数*.epub
- zip,压缩后的zip,内部有html5文档,可选via --zip参数*.zip
- svg对于web,html5<svg>独立文档, 印刷精美*.svg
- xml,通用xml,打印精美*.xml
- txt,无格式纯文本*.txt
- 更多
输入格式
- *.py, *.pywpython源代码文件、单个文件或整个文件夹 递归地。
独立异步单文件跨平台无依赖关系 Unicode python3多格式自动文档生成器。 想象一下我们把狮身人面像,潘多克,材料设计,mkdocs,电子书, Libreoffice Docs,K.I.S.S.Principle和去掉所有的臃肿, 然后就诞生了,享受“文档的黑暗面”!.