문서 작성

프로젝트 레이아웃

The Flower documentation lives in the docs 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 uv run --project .. 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 uv run --project .. 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 uv run --project .. make html

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