Django python sphinx文档

Django python sphinx文档,django,documentation,django-views,django-sphinx,sphinx4,Django,Documentation,Django Views,Django Sphinx,Sphinx4,有人能告诉我这个项目如何用于文档编制吗 我已在CentOS计算机上成功安装了它。安装后,自述文件显示要运行sphinx quickstart,文档的根目录为/home/tom/Docs 从这里到哪里如何使用/home/tom/Docs i have files中的命令 \u构建 conf.py index.rst make.bat Makefile \u静态 \u模板 下一步怎么办?如何为我的django项目生成报告,该项目位于/usr/my site好吧,你得自己阅读一下。但是,作为基本概述:

有人能告诉我这个项目如何用于文档编制吗

我已在CentOS计算机上成功安装了它。安装后,自述文件显示要运行sphinx quickstart,文档的根目录为/home/tom/Docs

从这里到哪里如何使用/home/tom/Docs i have files中的命令
\u构建
conf.py
index.rst
make.bat
Makefile
\u静态
\u模板


下一步怎么办?如何为我的django项目生成报告,该项目位于/usr/my site

好吧,你得自己阅读一下。但是,作为基本概述:

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

您是否阅读了斯芬克斯文档的任何部分?你读了哪些部分?你能提供一个让你困惑的Sphinx文档的具体引用吗?这是三个部分,1.定义文档结构2.添加内容3.运行构建。请帮助我理解这三个部分以及如何运行命令,如:ref:
rst primer
@Rajeev:你定义了文档吗?你写了什么内容吗?您是否尝试运行构建?你能更具体地说你不能做哪一步吗?@S.Lott:安装之后,我将我的一个项目复制到同一个目录,然后将conf.py和index.rst复制到此文件夹。然后运行sphinx build-b html admin builddir/然后它显示build successfull。我的问题是如何查看此报告谢谢,但在构建html之后,下一步是什么。@Rajeev:下一步是什么?HTML是您的文档。如果您喜欢()的话,可以用其他格式构建它,但是HTML很方便。