文档工具#

包 #

对于用户文档、贡献者指南和通信内容，我们使用

Sphinx

对于开发者 API 文档（特别是对于 JupyterLab js 仓库），我们使用

swagger

源文件格式 #

在开发 Sphinx 文档时，我们使用以下输入源文件格式

reStructuredText (.rst)
Markdown (.md)
Notebook (.ipynb)

应使用现代代码编辑器。有许多可用的编辑器，包括 Atom、SublimeText、gedit、vim、emacs。对于新贡献者来说，Atom 是一个不错的选择。

Sphinx 主题 #

我们的项目使用以下主题

sphinx_rtd_theme（目前由 Jupyter 项目使用）
jupyter_sphinx_theme（由 ipywidgets 使用）

Git 和 Github 资源 #

如果您是第一次使用 Github 或 git，您可以利用以下资源来了解这些工具。