创建文档

本节介绍如何使用 Sphinx 免费托管文档 Read The Docs .

安装Sphinx

使用 pip 安装狮身人面像：

pip install -U sphinx

有关其他安装方法，请参见 installation guide 狮身人面像。

斯芬克斯入门

创建一个 doc 项目中保存文档的目录：

cd /path/to/project
mkdir docs

跑 spinx-quickstart 里面 docs 目录：

cd docs
sphinx-quickstart

这将设置一个源目录，引导您完成一些基本配置，并创建一个 index.rst 文件以及 conf.py 文件。

您可以在中添加有关项目的一些信息 index.rst ，然后构建它们：

make html

有关生成过程的详细信息，请参见 guide 通过阅读文档。

其他来源

有关如何使用Sphinx和RestructuredText的详细指南，请参见 documentation tutorial 关于 Python 的搭车指南。