#author("2025-02-02T06:11:38+09:00","","")
#author("2025-02-02T23:41:29+09:00","","")
[[Smile：D]]
* 構成 [#pc85bf03]
xxxxx/
+- docs
+- manage.py
* インストール [#mde7744d]
pip install sphinx
pip install sphinx sphinx-autodoc-typehints
* ドキュメント作成環境構築 [#i634677d]
mkdir docs
cd docs
sphinx-quickstart
> ソースディレクトリとビルドディレクトリを分ける（y / n） [n]: y
> プロジェクト名: <プロジェクト名>
> 著者名（複数可）: <名前>
> プロジェクトのリリース []: <リリースバージョン:0.0.1 等>
> プロジェクトの言語 [en]: ja
設定ファイル: docs/source/conf.py を編集
import os
import sys
# Django の場合
import django
sys.path.insert(0, os.path.abspath("../..")
os.environ["DJANGO_SETTINGS_MODULE"] = "xxxxx/settings" # xxxxx は、プロジェクト名
django.setup()
～(省略)～
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
]
* source 自動生成 [#l8a4ab21]
cd ..
sphinx-apidoc -o docs/source .
* docs/source/index.rst に modules を追加 [#x3a1fc42]
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
* ドキュメント生成 [#q1454032]
make html
