Python/sphinx のバックアップ(No.1)

バックアップ一覧
差分を表示
現在との差分を表示
ソースを表示
Python/sphinx へ行く。
- 1 (2025-02-02 (日) 06:11:38)

構成 †

xxxxx/
  +- docs
  +- manage.py

↑

インストール †

pip install sphinx
pip install sphinx sphinx-autodoc-typehints

↑

ドキュメント作成環境構築 †

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 自動生成 †

cd ..
sphinx-apidoc -o docs/source .

↑

docs/source/index.rst に modules を追加 †

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

↑

ドキュメント生成 †

make html