Я пытаюсь автоматически документировать классы моей библиотеки в sphinx, и я хочу, чтобы они содержали две простые вещи:
Чтобы отобразить для каждого класса реализованные мной методы (обычный и __special __).
Для отображения для каждого класса унаследованных методов, которые были реализованы только внутри этого пакета.
С моей точки зрения, это очень распространенное желание, когда вы хотите документировать свою библиотеку, поэтому я надеюсь, что кто-то придумал, как это сделать.
Итак, мой текущий шаблон autodoc выглядит следующим образом:
:mod:`{{module}}`.{{objname}}
{{ underline }}==============
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}
:special-members:
Недостаточность этого шаблона наблюдалась по двум фактам:
Имея расширение панды DataFrame sphinx пытается импортировать все строки документации DataFrame и выдает большой вывод ошибок (intersphinx включен из conf.py), который не имеет ничего общего с моими определенными методами.
Документирование специальных методов сфинкса ABC импортирует множество методов, которые я не реализовал.