私は、Tastypie REST API用のAPIドキュメントを生成するために自動ドキュメントツールを使用しようとしています。私はtastytoolを試しましたが、APIの結果パラメータではなく、モデルの列が表示されているようです。その後、SphinxはSphinxをサポートしているので、Sphinxはより有望に見えましたが、コード内にAPIのコメントを入れて文書に生成する方法を示す例は見つかりません。&Tastypieドキュメントの生成
誰でも正確なコメントを書くための情報や例を共有でき、TastypieベースのAPI用のSphinx docを生成できますか？ありがとう。
tastypie-swaggerをご覧ください。Swaggerを使用して、Tastypie APIの/ doc /ページを生成します。
私はいくつかのマイナーな適応（これは、味の違いによるバージョンの違いのために必要でした）の後、いくらかの成功を収めました。
編集：私は必要であることがわかっ翻案（これはDjangoのバージョンに< 1.4とtastypieバージョン> 0.9.11）が今tastypie-闊歩のメインラインのブランチにマージされています。
おそらく私はあなたの質問のポイントを完全に見逃していますが、ソースディストリビューションに付属しているドキュメントを構築しようとしているのなら、必要なアクションを実行するMakefileがdocsディレクトリにあります。 html、json、latexなどのターゲット出力タイプを指定する必要があります。私は3つすべてをお互いに使用するので、django、tastypie、および眠りのためのドキュメントのローカルコピーを保持し、オプションmake htmlを使用します頻繁に。
あなたが達成しようとしていることについて私が間違っている場合、私たちは何らかの説明をすることができます。
申し訳ありませんの一部ですDjango Tasty Docsあります。 Sphinxでビルドインコマンドラインを使ってドキュメントを生成することはできますが、コード内に各APIのコメントを入れてドキュメントに生成するための正しい場所とフォーマットを見つけることができません。 –
Tastypieを利用する独自のAPIクラスのためにsphinxのドキュメントを作成しようとしていますか？ – zzzirk
tastypie-swaggerは最新のdjangoバージョンをサポートしていません。そのハードルを克服するためのアイデア？ありがとう –