Próbuję użyć Sphinx do udokumentowania Pythonamój projekt, ale zmagam się z różnicami między tym narzędziem a zwykłymi narzędziami, takimi jak JavaDoc, które mają udokumentować API. Oczywiście widzę, że Sphinx ma znacznie więcej zastosowań niż dokumentowanie API, ale wydaje się, że brakuje prostszego zadania.
ja udało aby dowiedzieć się, jak powiadomić Sphinx o strukturze paczki, aby nie musieć ręcznie replikować jej w plikach ReST. Mój następny problem to:
Czy możliwe jest dołączenie linku do źródła dla wszystkich klas z Sphinx?
Oczywiście źródło powinno być ładnie sformatowane, ale skoro Sphinx używa pygmentów, nie sądzę, żeby to był problem.
Odpowiedzi:
3 dla odpowiedzi № 1Spojrzeć na http://sphinx.pocoo.org/latest/ext/viewcode.html.
0 dla odpowiedzi nr 2
Dołącz rozszerzenie do pliku conf.py.
extensions = ["sphinx.ext.viewcode"]