贡献
构建文档
为了用pygeapi构建文档,我们使用 Sphinx 。文档位于docs文件夹中。
备注
要使以下说明起作用,您必须位于pyGeoapi的根文件夹中。
使用以下命令安装构建文档所需的依赖项:
pip3 install -r docs/requirements.txt
安装需求后,使用 sphinx-build
命令:
sphinx-build -M html docs/source docs/build
或使用以下内容 make
命令:
make -C docs html
生成文档后,文件夹 docs/build
将包含与文档一起生成的网站。将文件夹添加到Web服务器或打开文件 docs/build/html/index.html
文件,以查看文档的内容。
该文档托管在 readthedocs 。它是从 master
GitHub上的分支机构。
档案 .readthedocs.yaml
包含ReadtheDocs版本的配置。请参阅 readthedocs configuration file 文档以获取更多信息。
正在提供GitHub页面
请看 Contributing page 关于为项目捐款的信息。