介绍

本指南适用于拥有Python项目并希望通过将其与读取文档集成来改进文档的任何人。

在阅读文档的基础上托管项目文档有很多好处：

• 您的文档特定于您的代码版本。在开发分支中添加一个新功能，更新文档页面，提交，更新Github上的开发，在很短的时间内，开发分支的文档已经在readthedocs上更新，但至关重要的是，readthedocs上的主分支仍然显示特定于文档的o总分行。

• 您不必担心为文档托管网站，包括使其可搜索的所有麻烦等。

• 您可以在“读取文档”中配置从python代码到好看的可搜索文档页面的docstring自动转换。

本指南完全基于Github上的一个python项目，使用这里概述的技术。Github上的项目 (https://github.com/mattjhayes/docs-python2readthedocs) 可以用作配置的示例。它使用一个Webhook在项目提交时自动重建读取docs页。

项目中还包括两个简单的python程序来演示autoDoc功能。