文件工具#

軟體包#

對於使用者文件、貢獻者指南和溝通內容,我們使用

對於開發者 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,您可以利用以下資源來了解這些工具。