Python-Tornado官方文档是如何做到「文档与源码结合在一起的」?
本文介绍了Python-Tornado官方文档是如何做到「文档与源码结合在一起的」?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
问 题
描述问题
Tornado文档是自己接触到的Python方面较好的文档了,文档和源码合一
搜索了一下,使用了
Python-Sphinx
readthedocs.org
readthedocs-sphinx-theme
但是不知道具体是如何做到的
解决方案
由专注Tornado的我来回答这个问题吧~
这其实就是 Sphinx
的强大之处了! 在Tornado由代码注释自动生产文档这个事情中, 比较关键的是下面这几个扩展(姑且这么叫吧):
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
加上这些东西就可以直接拿出来源码中注释生成文档啦, 目录结构什么的主要就是在 .rst
文件中插入类似 automodule
或者 autoclass
之类的即可.
这篇关于Python-Tornado官方文档是如何做到「文档与源码结合在一起的」?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!
查看全文