Write documentation#
Project layout#
The Flower documentation lives in the doc
directory. The Sphinx-based documentation system supports both reStructuredText (.rst
files) and Markdown (.md
files).
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.
Edit an existing page#
Edit an existing
.rst
(or.md
) file underdoc/source/
Compile the docs:
cd doc
, thenpoetry run make html
Open
doc/build/html/index.html
in the browser to check the result
Create a new page#
Add new
.rst
file underdoc/source/
Add content to the new
.rst
fileLink to the new rst from
index.rst
Compile the docs:
cd doc
, thenpoetry run make html
Open
doc/build/html/index.html
in the browser to check the result