django - python sphinx 文档

Question

谁能告诉我这个项目如何用于文档目的 http://sphinx.pocoo.org

我已经在我的 CentOS 机器上成功安装了它。安装后自述文件说要运行 sphinx-quickstart 和 root 文档是 /home/tom/Docs

从这里到哪里我如何使用 /home/tom/Docs 中的命令我有文件 __build conf.py index.rst make.bat Makefile _static _templates

下一步是什么？如何为位于 /usr/my-site 中的 django 项目生成报告

Answer 1

好吧，你将不得不自己做一些阅读。但是，作为基本概述：

• 您通常会在项目的子文件夹中运行 sphinx-quickstart 以获取文档（例如/usr/my-site/docs）。
• 您以reStructuredText (rst) 格式编写 Sphinx 文档。首先编辑 index.rst 文件，以后可以添加更多文件。
• 完成后，使用make html（或 Windows 上的 make.bat html）从 RST 构建 HTML 文件。