编写文档

本文档简要介绍了如何编写Coala项目的文档。

文档以reStruredText编写，并由 Read the Docs 致我们可爱的用户。您可以在http://docs.coala.io.上查看当前用户文档

若要熟悉reStrutiredText语法，请参阅以下内容 guide .

在获得Coala源代码之后(请参见 Installation Instructions )，您可以开始破解现有的文档文件。它们驻留在可以找到的单独存储库中 here .

如果要添加新页，则需要更改 index.rst 文件位于存储库的根目录中。有关语法的解释，请阅读http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive。

您应该在尝试构建文档之前运行此命令：

pip3 install -r docs-requirements.txt

只需运行以下命令，即可在本地测试文档 python3 setup.py docs 在根目录中。这将生成 docs\_build\html\index.html 您可以在浏览器上查看。