Python-Tornado官方文档是如何做到「文档与源码结合在一起的」?

浮生若梦的编程
  • 2.8k

描述问题

Tornado文档是自己接触到的Python方面较好的文档了,文档和源码合一
搜索了一下,使用了

  1. Python-Sphinx

  2. readthedocs.org

  3. readthedocs-sphinx-theme

但是不知道具体是如何做到的

评论
阅读 2.1k
2 个回答
✓ 已被采纳

由专注Tornado的我来回答这个问题吧~

这其实就是 Sphinx 的强大之处了! 在Tornado由代码注释自动生产文档这个事情中, 比较关键的是下面这几个扩展(姑且这么叫吧):

    "sphinx.ext.autodoc",
    "sphinx.ext.coverage",
    "sphinx.ext.doctest",
    "sphinx.ext.extlinks",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",

加上这些东西就可以直接拿出来源码中注释生成文档啦, 目录结构什么的主要就是在 .rst 文件中插入类似 automodule 或者 autoclass 之类的即可.

源码里面写的有注释,生成文档的时候就有了。具体的步骤我也不知道,坐等楼下解答

宣传栏