Python的网站如何生成其在线文档?

时间:2010-05-18 11:41:41

标签: python directory python-sphinx restructuredtext

  

使用Sphinx 0.6.5创建。

我知道Python的文档使用reStructuredText,但它有不同的部分,如http://docs.python.org/whatsnew/2.6.htmlhttp://docs.python.org/tutorial/index.html

你如何在reStructuredText中做到这一点?你在一堆目录中运行rst2html,保持其结构吗?

我知道它使用Sphinx(而不是像Thomas Wouters in an answer那样直接使用rst2html),但你应该如何在存储库中组织包含源代码文件的第一个结构,这样你就拥有了一个完整的自动化文档网站?

3 个答案:

答案 0 :(得分:9)

Python文档使用reST作为其标记,但它使用sphinx而不是rst2html直接生成HTML。 sphinx工具可将所有单个.rst文件转换为多个.html文件。要了解如何生成Python文档,请参阅http://svn.python.org/projects/python/trunk/Doc/Makefile

答案 1 :(得分:4)

我发现sampledoc tutorial on the matplotlib site对于开始使用Sphinx非常有用。

答案 2 :(得分:2)