Epydoc - generowanie dokumentacji kodu

Opis narzędzia epydoc do generowania dokumentacji kodu Pythona na podstawie docstringów

epydoc to narzędzie do generowania dokumentacji z kodu Pythona (bazując na docstringach). Pakiet epydoc powinien być w repozytoriach różnych dystrybucji Linuksa. Instalacja samodzielna to:
python setup.py install
Po zainstalowaniu epydoc można przystąpić do generowania dokumentacji modułów Pythona. Żeby epydoc poprawnie rozpoznał nasz kod musi on znajdować się w PYTHONPATH. Wystarczy więc dodać katalog z naszym kodem do PYTHONPATH przy wywoływaniu epydoc:
PYTHONPATH=:/ścieżka/do/kodu/ epydoc --html -o katalog_na_dokumentacje moduł1 moduł2 moduł3...
W podanym katalogu zostanie wygenerowana dokumentacja w formacie HTML. W konsoli mogą pojawić się uwagi epydoca co do formatowania zawartości docstringów. Narzędzie to używa własnego zestawu znaczników do formatowania dokumentacji. W przypadku aplikacji Django trzeba podać jeszcze DJANGO_SETTINGS_MODULE (wykonując epydoc z katalogu projektu Django):
DJANGO_SETTINGS_MODULE=settings PYTHONPATH=:/ścieżka/do/projektu_django/ epydoc --html -o aplikacja_docs aplikacja.views
blog comments powered by Disqus

Kategorie

Strony