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

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

フォルダをモジュールとして成立させるためのファイルではなく、 「そのモジュールが何を API として公開するか」を定義するためのファイル。現代の Python では必須ではないが、設計を明確にするために使われる。