gendocs 0.4.0

Cookiecutter

想轻松创建一个会构建自己的文档的新项目？尝试 gendocs Cookiecutter，它将提示您输入新项目的详细信息，并为您的自动文档化Python包创建所有必要的文件结构。

要创建新项目，请确保您已在虚拟环境中安装了 Cookiecutter

$ pip install cookiecutter

现在您可以使用 我们的Cookiecutter模板 创建新项目，并通过执行以下命令并按照提示操作来准备使用 gendocs

$ cookiecutter https://github.com/banesullivan/cookiecutter-gendocs.git

这样就完成了！现在您有一个准备好的Python项目，可以自动生成文档和部署。

用法

已经有一个需要自动文档的Python包？请按照以下步骤操作。

本生成器是为 Sphinx (RST) 文档构建的。为了记录您的包，请设置 Sphinx 和一个 conf.py 文件，然后在您的 conf.py 文件的顶部附近添加以下内容。

# Import the package to document:
import wonderfulpackage

# Automatically generate documentation pages
from gendocs import Generator
Generator().DocumentPackages(wonderfulpackage)

这样就完成了！上面的代码块是您记录包（们）所需的所有操作。现在您可以构建 Sphinx 文档，所有文档页面都将自动生成。