sphinx：创建工程

创建sphinx工程

创建文档布局

创建项目文件夹，在根目录打开sphinx终端，运行以下命令：

sphinx-quickstart docs

提出创建项目的基本目录和配置布局所需的一系列问题的 docs 文件夹，按照自己的需求回答列出的问题即可。

• 独立的源文件和构建目录（y/n）[n]：y
• 项目名称：My First Doc
• 作者名称：SmartYe
• 项目发行版本 []：V1.0
• 项目语种：zh_CN

完成项目构建！

在根目录下可以看到创建的 docs 文件夹，目录中包含一下内容：

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

• build：保存呈现的文档
• make.bat，Makefile：编译脚本
• source/conf.py：配置文件
• source/index.rst：主页，包含根目录

终端运行以下命令，编译文档：

sphinx-build -b html docs/source/ docs/build/html

进入build文件夹，打开index.html查看文档效果。