自动文档生成
项目描述
介绍
docme是一个 python 应用程序，它的目标是减少编写冗余的 rst 文档。
它类似于 sphinx 内置autodoc模块，但docme的目标是创建更清洁的外观，
该自动文档不提供。
安装
只需使用 pip 安装程序：
pip install docme或者从 Github/Pypi 下载 src 文件并编写：
python setup.py install对于开发人员，请使用：
python setup.py develop从哪里开始
简单的开始
假设您的项目树是这样的：
.gitignore
src/
src/project/
src/project/file.py并且您希望创建项目的自动文档。
只需使用docme命令 - 这是一个指向 :func: docme.cli.main函数的入口点：
docme src/project doc其中src/project是主项目文件的路径，
doc是要创建的文档的目录。
结果是将创建一个名为doc的新文件夹，其中包含所有相关的 rst 文件，
新树将如下所示：
.gitignore
doc/
doc/api_reference/
doc/api_reference/project/
doc/api_reference/project/file.rst
doc/api_reference/project/index.rst
doc/api_reference/index.rst
doc/index.rst
src/
src/project/
src/project/file.py现在您可以简单地为 sphinx 添加make文件和conf.py以将 doc 编译为 html！
cd doc
make html包括外部文档
假设您已经有一些文档要包含在 api 参考中：
.gitignore
doc/
doc/how_to_start/
doc/how_to_start/advanced.rst
doc/how_to_start/intro.rst
doc/how_to_start/index.rst
src/
src/project/
src/project/file.py您可以像这样包含how_to_start部分：
docme src/project doc --extra-doc how_to_start/index请注意，这正是您需要添加到主index.rst的行。
新创建的树：
.gitignore
doc/
doc/how_to_start/
doc/how_to_start/advanced.rst
doc/how_to_start/intro.rst
doc/how_to_start/index.rst
doc/api_reference/
doc/api_reference/project/
doc/api_reference/project/file.rst
doc/api_reference/project/index.rst
doc/api_reference/index.rst
doc/index.rst
src/
src/project/
src/project/file.py在您的文档中，您可以从您的 api 引用类和函数！
像这样：
:class:`example<path.to.Class>`
