0

Problem

To fully use the autodoc potential, I want to document my code with something like:

.. automodule :: mymodule

However, mymodule is made of a class that has it's own documenter. One of my project's dependencies created a subclass of sphinx.ext.autodoc.ClassDocumenter that documents a class it provides. My mymodule is made up of classes derived from that base one. The custom documenter has an option I want to use, how do I provide it while using automodule?

Alternative formulation

Another case that I think is the same problem:

.. automodule :: mymodule

.. automodule :: myothermodule

These two modules are made of classes that will be documented with autoclass. I want to activate the ":inherited-members:" option for classes of the first mymodule but not on the ones of myothermodule. Is this possible?

Aule Mahal
  • 688
  • 5
  • 10

0 Answers0