本仓库维护π超算集群用户文档。本文档使用 reStructuredText(rst) 书写，并会被 Sphinx 编译为Web站点或PDF文档。本站使用的Web主题是 Material for Sphinx 。
Sphinx是一个将rst文档编译为HTML、PDF、eBook等出版物的python包，用于本文档网页渲染。在开始之前请确保本地已经有python环境。如果您的电脑暂时没有可用的python环境，那么我们建议您使用anaconda创建一个。
使用以下指令安装构建这个文档所需的Python包:
pip3 install -r requirements.txt
Windows用户检查sphinx是否安装完成:
where sphinx-build
Linux和Mac用户检查sphinx是否安装成功:
which sphinx-build
Pandoc 能够将markdown文档转换为rst文档，减少重复操作:
brew install pandoc pandoc -t index.md -o index.rst
生成HTML站点:
$ make -C docs html
查看HTML站点内容:
$ open docs/_build/html/index.html
生成PDF文档:
$ make -C docs latexpdf
查看PDF文档:
$ open docs/_build/latex/sphinx.pdf
远程仓库的 master 分支是受保护的，无法直接推送更新，需要推送到新分支，然后再从新分支发起合并请求。
新建本地分支，提交代码:
$ git checkout -b your_new_branch $ git commit -m "Your commit message"
推送更新到远程仓库:
$ git push origin your_new_branch
最后在GitLab页面中发起合并请求。