Skip to content Skip to sidebar Skip to footer

How Do I Document Members In Specific Sections Using Sphinx?

I'm struggling to figure out how to place the documentation for specific members of my Python class in specific sections of my Sphinx documentation, ideally while auto-documenting

Solution 1:

This works:

.. currentmodule:: my.module

.. automethod:: MyClass.funky

You could skip .. currentmodule:: and do it like this:

.. automethod:: my.module.MyClass.funky

A third option:

.. currentmodule:: my.module

.. autoclass:: MyClass   

   .. automethod:: funky

Post a Comment for "How Do I Document Members In Specific Sections Using Sphinx?"