3

いくつかの大きなアプリを含むプロジェクトがあり、設定ファイルとアプリ ファイルが分割されています。

ディレクトリ構造は次のようになります。

プロジェクト名

  • _init_.py _ _
  • アプリ
  • _init_.py _ _
  • アプリ1
  • app2
  • サードパーティ
  • _init_.py _ _
  • lib1
  • lib2
  • 設定
  • _init_.py _ _
  • installed_apps.py
  • path.py
  • テンプレート.py
  • locale.py
  • ...
  • urls.py

どのアプリもそうです

  • _init_.py _ _
  • 管理者
  • _init_.py _ _
  • file1.py
  • file2.py
  • モデル
  • _init_.py _ _
  • model1.py
  • model2.py
  • テスト
  • _init_.py _ _
  • test1.py
  • test2.py
  • ビュー
  • _init_.py _ _
  • view1.py
  • view2.py
  • urls.py

スフィンクスを使用してドキュメントを自動生成する方法は?

設定モジュールまたは INSTALLED_APPS (django.* または 3rdparty.* で始まらない) ごとにそのようなものが必要であり、docstring に基づく自動ドキュメント出力が必要です。

自動生成ドキュメントと git commit の前にテストを実行

ところで。私は手動で.rstファイルをやってみました

.. automodule:: module_name
   :members:

しかし、そのような大きなプロジェクトにはうんざりで、設定には機能しません

autogenメソッドか何かがありますか？

私は Sphinx に縛られていません。私の問題に対するより良い解決策はありますか?

4

2 に答える 2

2

  1. すべての Python パッケージ コンテンツのドキュメントを自動的に生成するを参照してください。

  2. 今後のSphinx 1.1リリースには、sphinx-apidoc.pyスクリプトが含まれています。

于 2011-03-14T16:12:44.367 に答える
1

ここではおそらくdjango-sphinx-autodocが役に立ちます。

ドキュメントから：

使い方

generate_autodoc.pyプロジェクト ディレクトリにファイルをコピーし、実行します。

.pyによってリストされた各アプリケーションのすべてのファイル をスクレイピングINSTALLED_APPし、DS_ROOT/modules.rst.

次に、2 つの異なるカテゴリにグループ化されたアプリケーションが表示されます。

  • 内部アプリケーションは、プロジェクト ディレクトリにあるアプリケーションです。
  • 外部アプリケーションは、pythonpath (できれば virtualenv) のどこかにあるアプリです。

良い習慣

__init__.pyアプリケーションのファイルにdocstring を追加して説明します。django-sphinx-autodoc が自動的にスクレイピングします。

于 2013-06-12T12:20:04.703 に答える