文档工具#

#

对于用户文档、贡献者指南和沟通内容,我们使用:

  • Sphinx 是一个强大的文档生成工具,广泛用于生成Python项目的文档。

对于开发者API文档(特别是JupyterLab js仓库),我们使用:

源文件格式#

在开发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,你可以利用以下资源来学习这些工具。