Jak dokumentować klasy bez nazwy modułu?
Usiłuję udokumentować pakiet Pythona za pomocąsphinx
i pomyślnie wygenerowałem pliki HTML. Pakiet, który dokumentuję, składa się z zestawu*.py
pliki, w większości zawierające jedną klasę z kilkoma plikami będącymi oryginalnymi modułami o zdefiniowanych funkcjach. Nie muszę ujawniać faktu, że każda klasa jest w module, więc dodałem odpowiedniąfrom
oświadczenia w__init__.py
plik np.
from base import Base
aby użytkownik mógł korzystać zimport pkg
polecenie i nie musi wtedy określać modułu zawierającego klasę:
import pkg
class MyBase(pkg.Base): # instead of pkg.base.Base ...
...
Problem polega na tym, że sfinks nalega na dokumentowanie klasy jakopkg.base.Base
. Próbowałem ustawićadd_module_names = False
wconf.py
. Jednak powoduje to, że sfinks pokazuje klasę po prostuBase
zamiastpkg.Base
. Dodatkowo niszczy to także dokumentację kilku*.py
pliki tosą moduły.
Jak zrobićsphinx
pokaż klasę jakopkg.Base
? A jak ustawićadd_module_names
selektywnie dla każdej z nich*.py
plik?