使用readthedocs 发布 sphinx doc文档

readthedocs 是由社区驱动的开源sphinx doc 托管服务，我们可以用来方便的构建以及发布文档

这是一个简单的demo 项目，使用了用的比较多的sphinx_rtd_theme 主题，主要是试用

注册账户

sphinx 文档需要让readthedocs 托管，我们需要一个账户，注册地址
https://readthedocs.org/ ，注册很简单，我们同时需要进行邮件验证

简单demo 项目

我们可以使用sphinx-quickstart 帮助我们生成简单的测试doc

 
         sphinx-quickstart 命令执行之后会有提示，按照提示操作即可 
        

简单操作参考：sphinx doc 简单试用

配置readthedocs

我们可以在项目中添加配置，方便readthedocs 进行构建，比如我们需要依赖sphinx_rtd_theme 主题的配置
参考配置：.readthedocs.yml 文件

           
         # .readthedocs.yml 
        
         # Read the Docs configuration file 
        
         # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 
        
         ​ 
        
         # Required 
        
         version: 2 
        
         ​ 
        
         # Build documentation in the docs/ directory with Sphinx 
        
         sphinx: 
        
           configuration: source/conf.py 
        
         ​ 
        
         # Build documentation with MkDocs 
        
         #mkdocs: 
        
         # configuration: mkdocs.yml 
        
         ​ 
        
         # Optionally build your docs in additional formats such as PDF and ePub 
        
         formats: all 
        
         ​ 
        
         # Optionally set the version of Python and requirements required to build your docs 
        
         python: 
        
           version: 3.7 
        
           install: 
        
             - requirements: requirements.txt