Sfinks - dokumentacja modeli Django

Question

Używam Sphinx do udokumentowania aplikacji Django, którą mam.

Podczas automatycznego generowania dokumentów chciałbym, aby Sphinx dodał pola każdego modułu w dokumentacji.

Sfinks całkowicie je pomija. W rzeczywistości nie ma żadnego śladu po polach.

Wszelkie pomysły?

James

Answer 1

Musisz użyć

@param description 

w docstring modelki, dla każdego pola chcesz być udokumentowane przez Sfinksa.

Lub alternatywnie, należy przyjrzeć się tej snippet że robi to, co chcesz (minus nudne część zapisu)

[EDIT]

Jeśli planujesz używać tego fragmentu, w Django> = 1,6

obj._meta._fields() 

została usunięta, należy zmienić go na

_meta.fields 

Answer 2

Jeśli planujesz używać tego snippet w Django 1.7+:

1. Miałeś do skonfigurowania projektu Django django.setup()
2. Zastosowanie obj._meta.get_fields() zamiast: obj._meta._fields()