Djangoモデルからドキュメンテーションを生成する方法は？

現時点では、プロジェクトのドキュメントにはSphinxを使用し、Djangoはフィールドの説明をモデル化しています。Djangoモデルからドキュメンテーションを生成する方法は？

主な問題は、モデルを変更した後、手動でSphinxドキュメントを更新し、ドキュメントのいくつかのフィールドを忘れたり、忘れたりすることがあります。

Djangoモデルに基づいてドキュメントを生成するツールはありますか？

出典

2016-06-16 A. Innokentiev

Djangoのためのドキュメントを生成するための最良の方法を - admindocsappを使用しています。

出典

2016-06-22 08:06:34

documentationは言う：

Djangoのドキュメントは順番にdocutilsのに基づいているSphinxのドキュメントシステムを、使用しています。基本的な考え方は、軽くフォーマットされたのプレーンテキストのドキュメントは、HTML、PDF、およびその他の出力フォーマットに変換されます。

したがって、djangoアプリケーション用のドキュメントを生成するには、sphinxを使用してください。あなたはスフィンクスのためにあなたのconf.pyでこれを入れて有効にするには、autodocの拡張機能を使用してスフィンクスにドキュメンテーション文字列からドキュメントを引っ張ってアクティブにする必要があります

extensions = [ 
    'sphinx.ext.autodoc', 
]

出典

2016-06-16 09:07:03

'verbose_name'に基づいてフィールド文書を生成することは可能ですか？ –

@ A.Innokentievはそれがデフォルトではありませんか？私はスフィンクスを使用していませんが、 'verbose_name'や（おそらくあなたが望むものに近い）' help_text'に関連するDjangoの標準的な振る舞いをsomに見てきました。 – MariusSiuram

@MariusSiuram私はツールを探しています。これは、Djangoモデルに基づいたドキュメント（フロントエンドの開発者用）を生成できます。私はいくつかのフィーチャーを望んでいます：いくつかのモデルフィールドを追加/削除したり 'verbose_name'を編集したりすると、自動的に更新されたドキュメントがあります。 –

Djangoモデルからドキュメンテーションを生成する方法は？

答えて

関連する問題