入门

为你的第一个贡献做准备

1. 我们的文档使用 reStructured Text、Markdown 和 Jupyter 笔记本。

2. 我们广泛使用 Sphinx 来构建文档。

3. 我们使用 Transifex 来帮助将文档翻译成多种语言。

4. 我们在 Read the Docs 上托管我们的文档。

开发你的贡献

Jupyter 的文档分布在多个项目中，这些项目列在 Jupyter 文档主页 上。这些说明适用于所有 Jupyter 项目，尽管有些项目有进一步的贡献指南。

克隆代码库

1. 在 GitHub 上分叉相应的项目代码库，具体取决于你想要为哪个项目的文档做出贡献。

2. 将代码库克隆到你的系统中。

编辑文档源文件

项目的源文件通常位于项目的 docs/source 目录中。reStructured 文本文件名以 .rst 结尾，Jupyter 笔记本文件以 .ipynb 结尾。

1. 在使用 reStructured 文本源文件时，在你最喜欢的文本编辑器中，对 .rst 文件进行所需的更改。

2. 如果需要编辑笔记本文件，则需要根据 安装 文档安装 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 群组或 GitHub 上的开放问题中提出问题。