python sphinx文档

Question

任何人都可以告诉我该项目如何用于文档目的http://sphinx.pocoo.org

我已成功将其安装在我的CentOS机器上。安装完成后，自述文件说运行sphinx-quickstart，文件根目录是/ 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文件。