Próbuję użyć Sphinx do udokumentowania ponad 5000 liniowego projektu w Pythonie. Posiada około 7 modułów bazowych. O ile wiem, aby korzystać z autodoc, muszę napisać taki kod dla każdego pliku w moim projekcie: .. automodule:: mods.set.tests :members: :show-inheritance: Jest to zbyt uciążliwe,...
Sphinx domyślnie nie generuje dokumentów dla __init __ (self). Próbowałem następujących rzeczy: .. automodule:: mymodule :members: i ..autoclass:: MyClass :members: W conf.py ustawienie następujących elementów tylko dołącza __init __ (self) docstring do klasy docstring ( dokumentacja Sphinx...
Próbuję rozpocząć pracę ze Sphinxem i wydaje mi się, że mam nieustające problemy. Komenda: docs/sphinx-quickstart Odpowiadam na wszystkie pytania i wszystko działa dobrze. Komenda: docs/ls Wszystko wygląda normalnie. Wynik:build Makefile source Komenda: sphinx-build -d build/doctrees source...
Używam sphinx i wtyczki autodoc do generowania dokumentacji API dla moich modułów Pythona. Chociaż mogę zobaczyć, jak ładnie udokumentować określone parametry, nie mogę znaleźć przykładu, jak udokumentować **kwargsparametr. Czy ktoś ma dobry przykład jasnego sposobu ich udokumentowania?...