Tastypie Dokumentation Generation

Question

Ich versuche Auto-Doc-Tool zu verwenden, um API-Dokument für Tastypie REST API zu generieren. Ich habe versucht, schmackhaftes Werkzeug, aber es scheint nicht die Ergebnisparameter der API, sondern die Spalten des Modells. Dann habe ich versucht, Sphinx scheint vielversprechend, da Tastypie Sphinx unterstützt, aber ich kann kein Beispiel finden, wo &, wie Sie einen Kommentar für die API innerhalb des Codes setzen, und generieren Sie sie in das Dokument.

Jeder kann einige Informationen oder Beispiele über korrekt schreiben Kommentar und generieren Sphinx Doc für Tastypie-basierte API? Vielen Dank.

Answer 1

Vielleicht möchten Sie einen Blick auf tastypie-swagger werfen, die Swagger verwendet, um eine/doc/Seite für Ihre Tastypie API zu generieren.

Ich hatte ein wenig Erfolg, nach ein paar kleinen Anpassungen (die wegen einer tastypie Version Unterschied notwendig waren, nehme ich an).

Edit: Die Anpassung ich für erforderlich (aufgrund einer django Version < 1.4 und tastypie Version> 0.9.11) werden nun in den Mainline-Zweig der tastypie-Prahlerei verschmolzen.

Answer 2

Vielleicht fehlt mir der Punkt Ihrer Frage vollständig, aber wenn Sie nur versuchen, die Dokumente zu erstellen, die mit der Quelldistribution kommen, gibt es ein Makefile im docs-Verzeichnis, das die notwendigen Aktionen ausführt. Sie müssen einen Zielausgabetyp wie html, json, latex usw. angeben. Ich behalte eine lokale Kopie der Dokumente für django, tastypie und schlummer, da ich alle drei in Verbindung miteinander verwende und ich die Option make html verwende häufig.

Wenn ich mich täusche über das, was Sie versuchen zu erreichen, können wir vielleicht zu einer Klärung kommen.

Answer 3

Es gibt auch Django Tasty Docs den Teil Tasty Tools