本文是 Jupyter 仓库中 IPython 开发指南的组成部分，讲解 IPython 及其衍生项目（包括 Jupyter 文档体系）中「如何写文档」的完整约定：从独立文档的 reStructuredText 格式与 Sphinx 构建流程，到面向用户 API 的 NumPy 风格 Docstring，再到文档发布（gh-pages）的操作步骤。

写Python这几年，我越来越觉得文档字符串（docstring）是代码里最容易“被低估”的部分。很多人把它当注释写，觉得“反正是给自己看的，随便写写就行”，结果半年后回来看代码，对着自己的函数一脸懵。还有人干脆不写，等用Sphinx生成API文档时，页面上干 ...