14

自動ドキュメントツールを使用して、TastypieRESTAPIのAPIドキュメントを生成しようとしています。Tastytoolを試しましたが、APIの結果パラメーターではなく、モデルの列が表示されているようです。次に、TastypieがSphinxをサポートしているため、Sphinxを試してみましたが、コード内のAPIのコメントをどこにどのように配置し、ドキュメントに生成するかを示す例が見つかりません。

誰でも正しくコメントを書いてTastypieベースのAPI用のSphinxドキュメントを生成するための情報や例を共有できますか?ありがとう。

4

3 に答える 3

13

tastypie-swaggerを確認することをお勧めします。これは、 Swaggerを使用してTastypieAPIの/doc/ページを生成します。

いくつかのマイナーな適応の後、私はそれである程度の成功を収めました(これはおいしいバージョンの違いのために必要だったと思います)。

編集:私が必要だと思った適応(djangoバージョン<1.4およびtastypieバージョン> 0.9.11のため)は、tastypie-swaggerのメインラインブランチにマージされました。

于 2012-11-28T15:39:36.800 に答える
4

TastyToolsの一部であるDjangoTastyDocsもあります

于 2013-01-24T23:02:20.837 に答える
0

おそらく私はあなたの質問の要点を完全に見逃していますが、ソースディストリビューションに付属するドキュメントを作成しようとしているだけの場合は、必要なアクションを実行するMakefileがdocsディレクトリにあります。html、json、latexなどのターゲット出力タイプを指定する必要があります。3つすべてを組み合わせて使用​​し、オプションをmake html頻繁に使用するため、django、tastypie、slumberのドキュメントのローカルコピーを保持しています。 。

あなたが成し遂げようとしていることについて私が間違っているなら、おそらく私たちはいくつかの説明に達することができます。

于 2012-10-12T20:59:28.580 に答える