为文档构建存储库结构#

存储库的根级别#

  • 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）