2012-08-20 10 views
5

Zastanawiam się, czy możliwe jest użycie POD (zwykłej starej dokumentacji) z Pythonem? I jak mam to zrobić?Czy można używać POD (zwykła stara dokumentacja) z Pythonem?

+2

Dlaczego tego potrzebujesz. Python ma swój własny format docstrukcji, który jest interpretowany przez 'pydoc'. Jeśli użyjesz POD, użytkownicy twojego modułu potrzebowaliby narzędzia do jego przeczytania. Jesteś pewien, że tego chcesz? Jeśli chcesz tylko udokumentować swój kod, użyj doctrowania Pythona. – javex

Odpowiedz

1

Wygląda na to, że nie ma bezpośredniej obsługi podpodłączania POD w pliku Pythona. Jednak moduły Pythona (w tym biblioteka standardowa Python) są dokumentowane przy użyciu reStructuredText. Zwykle odbywa się to przy użyciu Sphinx, która tworzy dokumentację z docstrukcji w formacie reStructuredText. Sphinx i pierwszy zostały specjalnie zaprojektowane do wypełnienia podobnej niszy do POD.

Powiązane problemy