9
Powiel możliwe:
Sphinx — combining automodule and autoclassPython: Sphinx: Jak automatycznie włączyć wszystkie klasy, metody i funkcje do dokumentacji sfinksa?
próbuję utworzyć dokumentacji HTML dla projektu zawierającego kilka tysięcy klas przy użyciu Sfinks i to plugin AutoDoc. Sphinx-apidoc tworzy wspaniałe pliki rst, ale brakuje automatycznego tworzenia autoclasses i autometods.
Czy istnieje sposób/polecenie/narzędzie w sfinksie do automatycznego uwzględniania w dokumencie wszystkich zmiennych, funkcji, klas i dekoratorów?
Niektóre przykładowy kod jednego RST-pliku:
tagger Package
=================
:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
:members:
:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
:members:
Czy sprawdziłeś już rozszerzenie '' autodoc' (http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc)? –
rozszerzenie autodoc jest dodawane w conf.py: extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] Sphinx wykrywa wszystkie moduły, ale nie wyświetla klas i metod. – Jon
Zgodnie z powyższym rozszerzeniem autodoc "Członkowie bez docstrukcji zostaną pominięci, chyba że podasz opcję flagi niedziałających członków" – intotecho