pj_root/ ├── docs # Sphinxでドキュメントを作成するディレクトリ └── src ├── run.py └── lib ├── __init__.py ├── template.py └── common ├── __init__.py └── decorator.py ...

Sphinx を使ってコードから綺麗な HTML ドキュメントを作るための最短実践ガイド 目的は「Python のソースに書いた docstring をそのまま HTML にして公開できる」こと。手を動かしながら学べるように、設定・書き方・コマンド・よくある落とし穴をまとめます。

__all__ の使用方法を説明するために、簡単な例を挙げてみましょう。想定するパッケージ構造は以下の通りです： my_package/ __init__.py module_a.py module_b.py ここで、module_a.py と module_b.py があるとします。 module_a.py module_b.py で __all__ を定義しているため、from my ...