维护文档
Sphinx 目录布局
FDI 使用 Sphinx 来生成、维护和格式化文档，这些文档位于 `fdi/docs/sphinx` 中：
sphinx
├── api
│ ├── api.rst
│ └── fdi
│ ├── fdi.dataset.resources.rst
│ ├── fdi.dataset.rst
│ ├── fdi.httppool.model.rst
│ ├── fdi.httppool.route.rst
│ ├── fdi.httppool.rst
│ ├── fdi.httppool.schema.rst
│ ├── fdi.pal.resources.rst
│ ├── fdi.pal.rst
│ ├── fdi.pns.resources.rst
│ ├── fdi.pns.rst
│ ├── fdi.rst
│ ├── fdi.utils.rst
│ └── modules.rst
├── conf.py
├── index.rst
├── Makefile
├── tree.txt
├── usage
│ ├── dataset.rst
│ ├── dockers.rst
│ ├── httppool.rst
│ ├── installation.rst
│ ├── pal.rst
│ ├── pns.rst
│ ├── product.rst
│ └── quickstart.rst
├── _static
│ ├── classes_dataset.png
│ ├── classes_pal.png
│ ├── classes_pns.png
│ ├── copy-button-yellow.svg
│ ├── copy-button.svg
│ ├── css
│ │ ├── copybutton.css
│ │ ├── custom.css
│ │ └── fdi.css
│ ├── css-sv
│ │ ├── aiohttp.css_t
│ │ ├── bootstrap.css
│ │ ├── bootstrap.min.css
│ │ ├── nature.css
│ │ ├── _bootswatch.scss
│ │ └── _variables.scss
│ ├── ipython_config.py1
│ ├── packages_dataset.png
│ ├── packages_pal.png
│ ├── packages_pns.png
│ └── product.png
└── _templates
├── about.html
├── layout.html
└── navigation.html
更新文档
使您的更改生效
随着 FDI 包的变化，在 FDI 包目录中运行以更新类/包图：
make docs_plots
运行
make docs_api
更新 API 文档
使用这个
make docs_html
在您修改上面的任何 .rst 文件或绘图或 API 信息已更新后。使用 Web 浏览器打开新生成的文档：example file:///D:/code/fdi/docs/html/index.html
翻译文档
TBW
见 https://www.sphinx-doc.org/en/master/usage/advanced/intl.html