Python官网是如何生成在线文档的?
使用 Sphinx 0.6.5 创建。
我知道 Python 的文档使用 reStructuredText
格式,但它有不同的部分,比如 http://docs.python.org/whatsnew/2.6.html
和 http://docs.python.org/tutorial/index.html
。
那么在 reStructuredText
中怎么做到这一点呢?是要在多个文件夹中运行 rst2html
,保持它的结构吗?
我知道它是使用 Sphinx(而不是直接使用 rst2html
,正如 Thomas Wouters 在一个回答中提到的),但你应该如何组织你的 rst 结构和源代码文件,以便在一个仓库中创建一个完整的自动化文档网站呢?
3 个回答
2
这里是 如何制作Python文档 的详细步骤。
4
我发现matplotlib网站上的这个示例文档教程对我开始使用Sphinx非常有帮助。
9
Python的文档使用了一种叫做reST的标记语言来格式化内容,但它不是直接用rst2html
来生成HTML页面,而是用一个叫sphinx
的工具。这个sphinx
工具负责把所有的.rst
文件转换成多个.html
文件。如果你想了解Python文档是怎么生成的,可以查看这个链接:http://svn.python.org/projects/python/trunk/Doc/Makefile