為文件構建儲存庫結構#

儲存庫的根級別#

  • docs 目錄：所有文件原始檔都放在這裡。

  • readthedocs.yml：readthedocs 的配置檔案，用於使用 conda 構建

The root level of the jupyter kernel_gateway repo. There are orange boxes surrounding two elements in the directory structure: the docs folder and the readthedocs.yml file. The docs folder is the first element in the directory. The readthedocs.yml file is the 12th item in the directory.

docs 目錄內部#

  • source 目錄：包含所有內容原始檔，格式為 .rst、.md 或 .ipynb

  • makefile：Sphinx 用於構建文件

  • environment.yml：conda 構建說明

The docs directory in the jupyter kernel_gateway repo (path: jupyter/kernel_gateway/docs). The first two elements in the directory are folders that have blue boxes surrounding them: and . The third and forth elements in the directory are files with orange boxes surrounding them: and . There are two more files in the directory, which have no visual emphasis.

Sphinx#

  • conf.py：Sphinx 配置檔案

  • index.rst 或 contents.rst：Sphinx 主目錄檔案

  • _static 目錄：包含影像、圖紙、圖示

  • _templates 目錄：覆蓋主題模板和佈局

  • build 目錄：Sphinx 生成的 html 檔案（不要將此目錄提交到 GitHub）