brew install sphinx-doc

pip install -U sphinx

sphinx-quickstart

欢迎使用 Sphinx 2.1.0 快速配置工具。

?

请输入接下来各项设置的值（如果方括号中指定了默认值，直接

按回车即可使用默认值）。

?

已选择根路径：.

?

布置用于保存 Sphinx 输出的构建目录，有两种选择。

一是在根路径下创建“_build”目录，二是在根路径下创建“source”

和“build”两个独立的目录。

> 独立的源文件和构建目录（y/n） [n]: y

?

项目名称会出现在文档的许多地方。

> 项目名称: dalongrongdemo

> 作者名称: dalong

> 项目发行版本 []: v1.0

?

如果用英语以外的语言编写文档，你可以在此按语言代码选择语种。

Sphinx 会把内置文本翻译成相应语言的版本。

?

支持的语言代码列表见：

http://sphinx-doc.org/config.html#confval-language。

> 项目语种 [en]: 

?

创建文件 ./source/conf.py。

创建文件 ./source/index.rst。

创建文件 ./Makefile。

创建文件 ./make.bat。

?

完成：已创建初始目录结构。

?

你现在可以填写主文档文件 ./source/index.rst 并创建其他文档源文件了。用 Makefile 构建文档，像这样：

 make builder

此处的“builder”是支持的构建器名，比如 html、latex 或 linkcheck。

tree build 

build

├── doctrees

│ ├── environment.pickle

│ └── index.doctree

└── html

    ├── _sources

    │ └── index.rst.txt

    ├── _static

    │ ├── alabaster.css

    │ ├── basic.css

    │ ├── custom.css

    │ ├── doctools.js

    │ ├── documentation_options.js

    │ ├── file.png

    │ ├── jquery-3.2.1.js

    │ ├── jquery.js

    │ ├── language_data.js

    │ ├── minus.png

    │ ├── plus.png

    │ ├── pygments.css

    │ ├── searchtools.js

    │ ├── underscore-1.3.1.js

    │ └── underscore.js

    ├── genindex.html

    ├── index.html

    ├── objects.inv

    ├── search.html

    └── searchindex.js

python3 -m venv venv

source venv/bin/activate

pip install sphinx_rtd_theme

html_theme = ‘sphinx_rtd_theme‘

make html