문서 작성

프로젝트 레이아웃

Flower 문서는 doc 디렉토리에 있습니다. Sphinx 기반 문서 시스템은 reStructuredText 텍스트(.rst 파일)와 Markdown(.md 파일)을 모두 지원합니다.

로컬에서 문서를 작성하려면(아래 설명과 같이 ``poetry run make html``로) `Pandoc <https://pandoc.org/installing.html>`_이 시스템에 설치되어 있어야 합니다.

기존 페이지 편집

  1. framework/docs/source/에서 기존 ``.rst``(또는 ``.md) 파일을 편집합니다

  2. Compile the docs: cd framework/docs, then 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 poetry run make html

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