Create class overview in sphinx like epydoc

227 Views Asked by At

Epydoc, which has long since ceased development, used to offer an extremely powerful overview of a class or module. For example, this:

enter image description here

Notice it shows the classes within the module with the first line or so of the doc-string. For functions it shows the function prototype as well with the start of the doc-string and optional arguments spelled out.

This is incredibly useful when browsing the documentation because one can look in rationally named classes/modules and easily find an appropriate function or method.

I'd like to have this similar feature in Sphinx but I cannot not find any example which demonstrates this. Frankly, I'm a little surprised because in all of the sea of praise of Sphinx, no one seems to care about this feature being absent, or at least absent as far as I can tell.

Does anyone know if there is a way to replicate something like the shown image in Sphinx?

0

There are 0 best solutions below