ドキュメントを生成する

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

# 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で確認できます

ライブプレビューする#

poetry run make livehtml

  • poetry run make livehtmlでライブレビューモードにできます

  • このコマンドを実行すると、ローカルサーバーが起動し、ブラウザでドキュメントが確認できます（http://localhost:8000/）

  • またドキュメントを編集して保存すると、自動でブラウザが更新されます

開発時の注意#

  • docs/apidocs/以下のAPIドキュメントは、各関数やクラスに記述したdocstringから自動生成されます

  • 関数やクラスのdocstringは必ず記述してください

  • また、ユーザー向けと開発者向けのドキュメントはそれぞれ別に用意しています

目次