文档工具#

软件包#

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

对于开发者 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,您可以利用以下资源来了解这些工具。