Generazione documentazione Tastypie

Question

Sto provando a utilizzare lo strumento auto-doc per generare doc dell'API per l'API REST di tasteypie. Ho provato tastetool, ma sembra che non mostri i parametri del risultato dell'API ma le colonne del modello. Poi ho provato che Sphinx sembra più promettente dal momento che Tastypie supporta Sphinx, ma non riesco a trovare un esempio per mostrare dove & come inserire il commento per l'API all'interno del codice e generarlo nel documento.

Chiunque può condividere alcune informazioni o esempi su come scrivere correttamente commenti e generare Sphinx doc per API basate su Tastypie? Grazie.

Answer 1

Si potrebbe dare un'occhiata a tastypie-swagger, che utilizza Swagger per generare una/doc/pagina per l'API Tastypie.

Ho avuto un po 'di successo con esso, dopo alcuni adattamenti minori (che erano necessari a causa di una differenza di versione di tasteypie, suppongo).

Edit: Gli adattamenti che ho trovato necessario (a causa di una versione di Django < 1.4 e la versione tastypie> 0.9.11) sono ora fuse nel ramo linea principale di tastypie-spavalderia.

Answer 2

Forse mi manca completamente il punto della tua domanda, ma se stai solo provando a creare i documenti forniti con la distribuzione di origine c'è un Makefile nella directory docs che esegue le azioni necessarie. Ti viene richiesto di specificare un tipo di output di destinazione come html, json, latex, ecc. Conservo una copia locale dei documenti per django, tastypie e sonnecchiare poiché li uso tutti e tre insieme e uso l'opzione make html frequentemente.

Se mi sto sbagliando per quello che stai cercando di realizzare, forse possiamo arrivare a qualche chiarimento.

Answer 3

C'è anche Django Tasty Docs che fa parte del Tasty Tools