[sphinx]生成文档的工具

• 安装:

1 pip install sphinx

• 新建文档项目

1 sphinx-quickstart

配置一些设置选项, 生成项目文件

• 生成html

1 make html
2 .\make.bat html    #windows

• 主题安装和使用

http://www.writethedocs.org/guide/tools/sphinx-themes/

 

Makefile：编译过代码的开发人员应该很是熟悉这个文件，若是不熟悉，那么能够将它看做是一个包含指令的文件，在使用 make 命令时，能够使用这些指令来构建文档输出。

_build：这是触发特定输出后用来存放所生成的文件的目录。

_static：全部不属于源代码（如图像）一部分的文件均存放于此处，稍后会在构建目录中将它们连接在一块儿。

conf.py：这是一个 Python 文件，用于存放 Sphinx 的配置值，包括在终端执行 sphinx-quickstart 时选中的那些值。

index.rst：文档项目的 root 目录。若是将文档划分为其余文件，该目录会链接这些文件。

 

reStructuredText 标记语法

https://pythonhosted.org/an_example_pypi_project/sphinx.html

 

详细教程文档:

http://zh-sphinx-doc.readthedocs.io/en/latest/index.html

 

教程:

https://www.jianshu.com/p/78e9e1b8553a