1

私はSphinxを使用してDjangoプロジェクトのドキュメントを生成していますが、これは非常にうまく機能しています。ただし、.rstファイルを自分で作成する必要があるようです。作成が完了すると、make HTMLを実行すると、sphinxがdocstringからドキュメントをコンパイルします。

私の質問は次のとおりです。.rstファイルを手動で編集しなくても、プロジェクトへの新しい追加を自動的に反映するドキュメントを探しています。

Djangoのすべてがいつもとてもシンプルに見えるので、プロジェクト全体の最初のファイルを手動で作成しなければならないのは奇妙だと思います。プロジェクトの構造を自動的に検査してビルドする何かがすでに存在していると思いました。それからの最初のもの。

私はこのプロジェクトhttp://pypi.python.org/pypi/django-sphinx-autodoc/0.0を見てきましたが、これは有望に見えますが、これ以上成熟したものがないことに驚いています。

4

1 に答える 1

1

しばらくの間、SphinxapidocはSphinxにバンドルされています。.rstこれにより、ファイルのフルセットを作成できます。

1つのサイトで使用するさまざまなdjangoアプリケーションをすべて文書化する場合は、さらに問題になります(これはあなたが望むもののようです)。Sphinx apidocは、Pythonパッケージをスキャンするための一連のディレクトリを必要としています。

于 2012-11-18T19:39:22.113 に答える