Я документирую код Python, который имеет несколько уровней наследования, используя Sphinx. Структура примерно такая:
class _foo(np.ndarray):
#do _foo stuff
class bar(_foo):
#do bar stuff
class baz(_foo):
#do baz stuff
With: inherited-members: в моем .rst файле я получаю документацию от _foo как часть bar и baz, но я также получаю всю документацию из np.ndarray, чего я не хочу.
В документации Sphinx (https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) говорится:
Например; Если ваш класс Foo является производным от класса списка и вы не хотите документировать list .__ len __ (), вы должны указать опцию : inherited-members: list , чтобы избежать специальных членов класса списка.
Но я пробовал:
- : унаследованные-члены: np.ndarray
- : унаследованные-члены: ndarray
- : унаследованные -members: numpy .ndarray
Ничто из этого не препятствует включению всей документации numpy .ndarray для каждого отдельного класса. Кто-нибудь знает, есть ли способ исключить документацию numpy, но оставить нужные мне части? Спасибо.