現在、Django プロジェクトのドキュメント用に Sphinx を評価しています。これは、プロジェクトに緊密に結合された複数のアプリで構成されています。私が達成しようとしていることの 1 つは、カテゴリ別にグループ化されたドキュメントのページを生成することです。これはすべて手動で行うこともできますが、自動化できることを願っています。
具体的には、定期的に生成される autodoc ドキュメントに加えて、すべての概要を提供するドキュメントのページが欲しいです...
- モデル
- ミドルウェア
- ビュー
- コンテキスト プロセッサ
- 信号
- テストケース
のような典型的なアプリ構造から
├── myapp
│ ├── forms.py
│ ├── __init__.py
│ ├── models.py
│ ├── templates
│ │ └── sometemplate.html
│ ├── tests.py
│ ├── urls.py
│ └── views.py
└── otherapp
├── context_processors.py
├── __init__.py
├── middleware.py
├── models.py
├── someotherfile.py
├── signals.py
├── templates
│ └── othertemplate.html
└── tests.py
および（おそらく）docstring
class MyView(View):
"""Displaying ...
Some info about this View.
.. category::
django_view
"""
次のようなドキュメントでのレンダリング
ビュー
myapp.views.MyViewこのビューに関する情報。
otherapp.views.OtherViewこの OtherView に関する情報。
django-sphinx-autodocは、おそらくアプリを見て回るのに役立つでしょう。私がやりたいことをするためにdjango-sphinx-autodocを拡張/変更する必要がありますか? これを取得するための他のアプローチをアドバイスしていただけますか？それとも、これをすべて手動で行うのが唯一の方法ですか?