使用sphinx发布python API文档到readthedocs的配置

1. 创建你的本地项目python项目。

cd your/project
pip install sphinx

2. 在项目的根目录下创建一个docs文件夹，用于存放你的文档。

cd docs
sphinx-quickstart

        2.1 在docs目录下创建一个requirements.txt。

        这个文件是用于告诉readthedocs服务器在创建Linux容器安装python环境时需要安装的项目依赖。这个文件很重要，几乎决定了你的文档会不会在readthedocs上能不能成功的生成。

        在这个文件中，你需要写明，你想让readthedocs需要的一些外部依赖，和你的python项目中使用到的所有依赖。

        

# readthedocs 需要用到的主题依赖
sphinx_rtd_theme

# python项目中要用到的依赖
pathlib
sparc_me
numpy
pandas

        如果不添加这些依赖，那么你的项目百分之九十的会遇到本地运行 make html时能生成相对应的python API文档，但是在readthedocs上却生成不了的问题。所以，一定要将你python项目中要用到的依赖全部添加到这个requirements.txt文件中。

        2.2 在docs/source目录下，配置conf.py文件

                在这个文件中，你可以配置项目文档的基本信息，作者，项目名，文档样式等。最为重要的是，你需要将你python项目的相对路径配置到read