编写文件

项目布局

Flower 文档位于 doc 目录中。基于 Sphinx 的文档系统支持 reStructuredText（.rst 文件）和 Markdown（.md 文件）。

Note that, in order to build the documentation locally (with python -m poetry run make html, as described below), Pandoc needs to be installed on the system.

编辑现有页面

1. 编辑 framework/docs/source/ 下现有的 .rst (或 .md) 文件

2. Compile the docs: cd framework/docs, then python -m poetry run make html

3. Open framework/docs/build/html/index.html in the browser to check the result

创建新页面

1. 在 framework/docs/source/ 下添加新的 .rst 文件

2. 为新的 .rst 文件添加内容

3. 从 index.rst 链接到新的 rst

4. Compile the docs: cd framework/docs, then python -m poetry run make html

5. Open framework/docs/build/html/index.html in the browser to check the result