入门#
准备你的首次贡献#
我们的文档使用 reStructured Text、Markdown 和 Jupyter 笔记本。
我们广泛使用 Sphinx 来构建文档。
我们使用 Transifex 来帮助将文档翻译成多种语言。
我们在 Read the Docs 上托管我们的文档。
开发你的贡献#
Jupyter 的文档分布在多个项目中，列在 Jupyter 文档主页 上。这些说明适用于所有 Jupyter 项目，尽管有些项目有进一步的贡献指南。
克隆仓库#
在GitHub上分叉相应的项目仓库，具体取决于你想为哪个项目的文档做出贡献。
将仓库克隆到您的系统中。
编辑文档源文件#
项目源文件通常位于项目的 docs/source 目录中。reStructuredText 文件名以 .rst 结尾，而 Jupyter notebook 文件以 .ipynb 结尾。
在你喜欢的文本编辑器中，当处理 reStructuredText 源文件时，对
.rst文件进行所需的更改。如果需要编辑笔记本文件，您需要根据 安装 文档安装 Jupyter 笔记本。然后，运行 Jupyter 笔记本并编辑所需文件。在保存 Jupyter
.ipynb文件之前，请清除输出单元格。保存文件并测试您的更改。
测试更改#
应安装 Sphinx 以测试您的文档更改。为了获得最佳效果，我们建议您安装稳定的开发版本 Sphinx（pip install git+https://github.com/sphinx-doc/sphinx@stable）或当前发布的 Sphinx 版本（pip install sphinx）。
此外，您可能需要以下包：sphinxcontrib-spelling、sphinx_rtd_theme、nbsphinx、pyenchant、recommonmark 0.4.0 和 jupyter_sphinx_theme，这些可以通过 pip install sphinxcontrib-spelling sphinx_rtd_theme nbsphinx pyenchant recommonmark==0.4.0 jupyter_sphinx_theme 安装。
如果你使用的是Linux，你可能还需要通过运行 sudo apt-get install enchant 来安装Enchant C库。
一旦所有内容都安装完毕，应从 docs 目录使用终端/命令行执行以下命令：
make html构建了文档的本地html版本。输出信息将显示错误或提供html文档的位置。例如，提供的位置可能是build/html，要在浏览器中查看这些文档，请输入open build/html/index.html。make linkcheck将检查文档中的外部链接是否有效，或者它们是否不再当前（即导致 500 未找到错误）。
注意：我们推荐使用 Python 3.4+ 来构建文档。如果你正在编辑文档，可以使用 Python 2.7.9+ 或 Github 编辑器。
创建一个拉取请求#
一旦你对你的修改满意，请按照上述指示提交一个GitHub拉取请求。如果文档更改与一个开放的GitHub问题相关，请在拉取请求信息中提及问题编号。
项目评审员将审查您的更改并提供反馈或将您的更改合并到文档中。
提问#
欢迎在Jupyter的Google Group中提问，或在GitHub上的开放问题中讨论。