Avoid documenting inherited method

[peastman]

I'm generating documentation for classes that extend torch.nn.Module, which has a ton of methods. I don't want to include the inherited methods in my documentation, just the ones I wrote myself.

Here's how I define the options in conf.py.

autodoc_default_options = {
    "members": True,
    "member-order": "bysource",
}

Since I don't include inherited-members, I don't expect them to be documented. And in fact the "On this page" sidebar only lists the methods in my subclass. But the main "Methods" section still lists all of them:

If I add "inherited-members": True then they appear in both places. But I don't want them to appear in either. How do I make that happen?

I'm using Sphinx 9.1.0 and pydata-sphinx-theme 0.20.0.

[parulin]

Have you tried to provide the name of the classes to exclude?

[peastman]

Yes, that didn't work either.

[parulin]

There is something missing from the context here. The default behavior is to hide inherited methods, if you add inherited-members it should show them and if you put torch.nn.Module in inherited-members it should exclude those methods...

[parulin]

Isolate a minimal documentation example to reproduce your issue.

[peastman]

The way I eventually solved this was to override class.rst to delete the block that lists methods:

   {% if methods %}
   .. rubric:: {{ _('Methods') }}

   .. autosummary::
   {% for item in methods %}
      ~{{ name }}.{{ item }}
   {%- endfor %}
   {% endif %}

The inherited-members option affects whether it produces detailed documentation on each inherited method, as you can see from the sidebar in the image above. But it doesn't affect the summary table generated by that code.