Sfinge - Documentazione di modelli Django

Question

Uso Sphinx per documentare un'applicazione Django che ho.

Durante la generazione automatica di documenti, desidero che Sphinx aggiunga i campi di ciascun modulo all'interno della documentazione.

La Sfinge lo salta completamente. Di fatto non c'è traccia dei campi.

Qualche idea?

James

Answer 1

è necessario utilizzare

@param description 

nella docstring del modello, per ogni campo che si desidera essere documentato da sfinge.

O, in alternativa, si dovrebbe dare un'occhiata a questo snippet che fa quello che si vuole (meno la parte di scrittura noioso)

[EDIT]

Se si prevede di utilizzare questo frammento, in Django> = 1,6

obj._meta._fields() 

è stato rimosso si prega di cambiarlo in

_meta.fields 

Answer 2

Se si prevede di utilizzare questa snippet, in django 1.7+:

1. Si doveva impostare il progetto django django.setup()
2. Usa obj._meta.get_fields() invece di: obj._meta._fields()