Python 爬阶梯 | 将你的 Docstring 生成在线 HTML 文档

当你写完了程序,加上了 Docstring ,准备给别人参考使用的时候,可以把 Docstring 生成在线的文档,这样别人可以直接访问网页来了解的项目功能以及使用,在这里就不得不提的一个神器叫做 sphinx ,它提供了一些命令工具可以很方便的将你代码中的解释直接生成网页,也就是说,只要在你的项目里面使用 sphinx 命令,就可以将你的项目文档生成 HTML。

今天,就来告诉你如何将 Docstring 生成在线文档。

首先你需要安装一下 sphinx:

pip install -U sphinx

安装完之后就可以在你的当前项目中使用 sphinx 了,这里我创建一个 doc_test 项目为例给你演示一下:

本文隐藏内容 登陆 后才可以浏览
完事之后你的 docs 目录会多了个 build 文件,里面存放了所有生成好了的 HTML 文件:

通过浏览器打开 index.html 你就可以看到你的 Docstring 直接生成网页的形式,可以被轻松的访问了:

这就可以很轻松的让别人了解你写的项目或者模块的具体使用,特别是你提供一些
API 的时候,sphinx 是一个值得使用的工具。

发表评论

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