0

私はdjangoアプリとして書かれたプロジェクトを持っています。頻繁な変更の最中ですが、クライアントは私のプロジェクトで最新のデータベース モデルを変更することを主張しています。libreoffice ドキュメントを作成し、djangomodels.pyファイルの最新のテーブル/列の変更で更新する必要がありました。煩わしくなり始めました。

help_textだから、djangoモデルからモデルメタデータ(クラスドキュメント、、Fieldクラス、関係など)から情報を抽出し、素敵なドキュメント(TXT / TeX / ODF / PDFなど)を作成するために利用できるツールまたはdjangoアプリがすでにあるのは不思議です。それの?django はすでに SQL コマンドを生成できるので、可能だと思います。

助言がありますか?

私の頭にあるドキュメントには、各 DB テーブルを説明するための段落 (モデル クラスの docstring から) と、フィールド名とその説明、および可能な DB 属性 (インデックス付き、一意、列の型) の箇条書きのリストをそれらの前に含めることができます。

4

1 に答える 1

2

pydoc使用されている docstring から基本的なドキュメントを提供できますが、より完全なドキュメント セットについては、Python と Django の両方のドキュメント Web ページとダウンロードを作成するために使用されるSphinxを使用することをお勧めします。

于 2013-10-14T09:52:01.390 に答える