10

使用 Sphinx 0.6.5 创建。

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

你如何在 reStructuredText 中做到这一点？您是否rst2html在一堆目录中运行并保持其结构？

我知道它使用 Sphinx（不是Thomas Wouters 在回答中直接说的 rst2html ），但是您应该如何在存储库中使用源代码文件组织您的第一个结构，以便拥有一个完整的自动化文档网站？

4

3 回答 3

9

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

于 2010-05-18T12:30:30.037 回答
4

我发现matplotlib 网站上的 sampledoc 教程对于开始使用 Sphinx 非常有用。

于 2010-05-18T12:53:36.327 回答
2

下面是如何准确地构建 Python 文档。

于 2014-02-12T08:09:55.920 回答