为文档构建仓库结构#

仓库的根级别#

  • docs 目录 : 所有文档的源文件放在这里。

  • readthedocs.yml : 用于readthedocs的配置文件,以便使用conda进行构建

jupyter kernel_gateway 仓库的根目录级别。目录结构中有两个元素被橙色框包围:docs 文件夹和 readthedocs.yml 文件。docs 文件夹是目录中的第一个元素。readthedocs.yml 文件是目录中的第12个项目。

在文档目录内#

  • source 目录 : 包含所有内容源文件,格式为 .rst.md.ipynb

  • makefile : 由 Sphinx 用于构建文档

  • environment.yml : conda 构建指令

jupyter kernel_gateway 仓库中的 docs 目录(路径:jupyter/kernel_gateway/docs)。目录中的前两个元素是带有蓝色框包围的文件夹: 和 。目录中的第三和第四个元素是带有橙色框包围的文件: 和 。目录中还有两个文件,没有视觉强调。

Sphinx#

  • conf.py : Sphinx 配置文件

  • contents.rstindex.rst : Sphinx 主目录文件

  • _static 目录 : 包含图片、绘图、图标

  • _templates 目录:覆盖主题模板和布局

  • build 目录 : Sphinx 生成的 HTML 文件 (不要将此目录提交到 GitHub)