快速构建第一个Sphinx项目

快速构建Sphinx项目模板

(.venv) sphinx-quickstart docs

该命令会自动创建项目的基本目录和配置布局，但是还需要继续回答下述问题才能完成构建：

• > Separate source and build directories (y/n) [n]: y 输入“y”(不带引号)，然后按 Enter 。
• > Project name: Sphinx Test 输入项目名称，然后按 Enter 。
• > Author name(s): dev-seq 输入作者名称，然后按 Enter 。
• > Project release []: 0.1 输入项目释放版本号，然后按 Enter 。
• > Project language [en]: zh_CN 输入项目语言，空默认为英语，然后按 Enter 。

构建完成后，新的docs目录下将包含以下内容。

docs
├── build
├── make.bat
├── Makefile
└── source
   ├── conf.py
   ├── index.rst
   ├── _static
   └── _templates

这些文件中的每个文件的目的是：
build/    一个空目录,保存编译生成的文档。
make.bat and Makefile    编译脚本
source/conf.py    保存Sphinx项目配置的一个Python脚本。
source/index.rst    这个 root document 作为欢迎页面，并包含“目录树”的根(或 toctree )。
到此，一个完整的Sphinx项目已经构建完成了，你可以运行下面指令编译;

(.venv) cd docs
(.venv) make html

最后，打开 docs/build/html/index.html 在您的浏览器中。您应该会看到类似这样的内容：