使用ReadtheDocs托管文档

  Read the Docs是一个在线文档托管服务,你可以从各种版本控制系统中导入文档,如果你使用github,那么每次提交代码后可以自动构建并上传至readthedocs网站,非常方便。

Sphinx

  Sphinx是一个基于Python的文档生成项目,最早只是用来生成 Python 官方文档,随着工具的完善, 越来越多的知名的项目也用他来生成文档,甚至完全可以用他来写书采用了reStructuredText作为文档写作语言, 不过也可以通过模块支持其他格式,之后我会介绍怎样支持MarkDown格式。

安装Sphinx:

初始化:

下面是我的配置

修改构建docs的配置文件

更改source/conf.py:

从代码生成rst文件

./source是index.rst所在的路径,../code/是你的代码所在的路径

本地构建/预览

运行

进入build/html目录后打开index.html预览。

rst格式/代码文档解析

可以使用automodule来自动发现模块。

index.rst

utils.rst

发表评论

电子邮件地址不会被公开。 必填项已用*标注