自动文档生成
docme的Python项目详细描述
简介
docme是一个python应用程序，其目标是减少编写冗余的rst文档。
它类似于sphinx内置的autodoc模块，但是docme的目标是创建更干净的外观，
不提供autodoc。
安装
只需使用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
现在您只需添加makefile和conf.pysphinx就可以将文档编译成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
注意，这正是您需要添加到mainindex.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>`
欢迎加入QQ群-->： 979659372
