Pytania otagowane jako autodoc

6
Sphinx autodoc nie jest wystarczająco automatyczny
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, ponieważ mam wiele plików. Byłoby znacznie łatwiej, gdybym …
5
Jak użyć autodoc Sphinx do udokumentowania metody __init __ (self) klasy?
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 autodoc wydaje się zgadzać, że jest to oczekiwane zachowanie, ale nie wspomina o …
7
sphinx-build fail - autodoc nie może zaimportować / znaleźć modułu
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 build/html Wydaje się, że działa. Udało mi się otworzyć plik index.html i zobaczyć „powłokę” …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.