Python: 使用sphinx生成python项目文档

前言

本篇记录使用sphinx生产成python项目文档的方法。

安装sphinx

直接通过pip安装sphinx：

pip install sphinx

生成配置文件

进入项目根目录，创建doc文件夹，生成配置文件：

mkdir doc
cd doc
sphinx-quickstart

出现以下提示：

Separate source and build directories (y/n) [n]: y
Project name: 
Author name(s): 
Project version []: 
Project language [en]: 

修改配置文件

安装sphinx主题美化文档：

pip install sphinx_rtd_theme

修改doc/source/conf.py文件：