tornado文档生成器使用Sphinx,是如何将代码docstring和文档混合在一起去的?

Question

一. 描述问题&上下文环境

依据官网教程, 使用Sphinx命令行工具时, 生成的文档目录下,我能用rst写文档/书/博客文章等等

但是一个开源项目的api文档和上述用途, 还是很不一样的

1. API文档, 需要同时混合docstring和开发者手写文档, 将它们有机混合在一起, 这个过程是如何进行的?

2. 由网页端,还可看到tornado的api源码, 如何做到的?

py2.7.11-最新Sphinx-Ubuntu命令行使用Sphinx

二. 相关代码&重现

三. 报错信息

四. 相关截图

五. 已经尝试哪些方法仍然没有解决(附上相关链接)

1. 猜想Sphinx应该拓展了这种rst语法, 但是没有搜索到

2. 我使用Sphinx的姿势不对(命令行工具 sphinx-quickstart)

搜索了Sphinx官网, 使用Sphinx练习了几个项目, 未果

• tornado文档: http://www.tornadoweb.org/en/stable/

六.问题简化

Answer 1

详细的插件都在主配置文件里面

https://raw.githubusercontent...

比较特别的几个插件是

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.coverage",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
]

具体怎么使用就需要一个个详细试用了。