Python到readthedocs指南

一本关于将Python项目与阅读文档集成以创建非常方便的文档的初学者指南。本指南适用于拥有Python项目并希望通过将其与读取文档集成来改进文档的任何人。 在阅读文档的基础上托管项目文档有很多好处：您的文档特定于您的代码版本。在开发分支中添加一个新功能，更新文档页面，提交，更新Github上的开发，在很短的时间内，开发分支的文档已经在readthedocs上更新，但至关重要的是，readthedocs上的主分支仍然显示特定于文档的o总分行。 您不必担心为文档托管网站，包括使其可搜索的所有麻烦等。 您可以在“读取文档”中配置从python代码到好看的可搜索文档页面的docstring自动转换。