# ドキュメントを生成する

```bash
# docsディレクトリに移動する
cd haniwers/docs

# sphinxを実行する
poetry run make html
```

- `poetry run make html`でドキュメントをビルドできます
- このプロジェクトでは`sphinx`を使っています
- ドキュメントの設定は`docs/conf.py`で確認できます
  - テーマは`sphinx_book_theme`を利用しています
  - `myst_parser`プラグインを導入しており、Markdown形式が利用できます
- ビルドの設定は`docs/Makefile`で確認できます

## ライブプレビューする

```bash
poetry run make livehtml
```

- `poetry run make livehtml`でライブレビューモードにできます
- このコマンドを実行すると、ローカルサーバーが起動し、ブラウザでドキュメントが確認できます（`http://localhost:8000/`）
- またドキュメントを編集して保存すると、自動でブラウザが更新されます

## 開発時の注意

- `docs/apidocs/`以下のAPIドキュメントは、各関数やクラスに記述した**docstring**から自動生成されます
- 関数やクラスのdocstringは必ず記述してください
- また、ユーザー向けと開発者向けのドキュメントはそれぞれ別に用意しています