编写文件#
项目布局#
Flower 文档位于 doc
目录中。基于 Sphinx 的文档系统支持 reStructuredText(.rst
文件)和 Markdown(.md
文件)。
Note that, in order to build the documentation locally (with poetry run make html
, like described below), Pandoc needs to be installed on the system.
编辑现有页面#
编辑
doc/source/
下现有的.rst
(或.md
) 文件编译文档: cd doc``,然后
poetry run make html
在浏览器中打开
doc/build/html/index.html
查看结果
创建新页面#
在
doc/source/
下添加新的.rst
文件为新的
.rst
文件添加内容从
index.rst
链接到新的 rst编译文档: cd doc``,然后
poetry run make html
在浏览器中打开
doc/build/html/index.html
查看结果