开源文档使用sphinx编译,并放在read the docs上托管。建议用github登录read the docs。需在github,setting的Applocations中的Authorized OAuth Apps绑定Read the Docs Community。绑定之后可以在项目中添加仓库绑定分支。
文档源代码以及生成的html存放在docs_spinx目录下。在文档的目录下make html编译出hetml,在html的目录中运行python -m http.server 8000查看本地html.
read the docs编译需要requirements.txt和.readthedocs.yaml文件。并且与github仓库绑定,上传的代码会实时更新read the docs.
文档的内容都放在docs_sphinx下的source下。主目录的index.rst是首页,目前主要是承担目录的作用。
conf.py是sphinx的配置文件