feature: Hide attributes, but render in summary

[reteps]

Is your feature request related to a problem? Please describe.

I have a lot of type heavy classes I would like to document. I would like the option to only show their members in the summary table, but not show the attributes.

For example, I want to show this summary table:

But I do not want to show:

This is because the attributes take up too much space, and do not show any useful information.

Describe the solution you'd like

I would like the ability to either:

• Collapse a group of stuff (e.g. attributes) inside an admonition
• Hide a section (e.g. attributes), but keep them in the summary

Describe alternatives you've considered

I looked at the source code, and summary mirrors attributes exactly, so there is not existing way to do this without overriding templates.

[pawamoy]

Hi @reteps, thanks for the request.

When you say "summary table", do you mean you're using the summary option, or do you have an Attributes section written manually in your class docstring?

[pawamoy]

The long term issue with not rendering headings for attributes is that they won't be included in the objects inventory, meaning your users (and yourself!) won't be able to cross-references these attributes.

The way to solve this would be #133. But in the meantime, there's no configuration option to achieve what you want, and the only way is to override templates indeed.

[pawamoy]

I'll close in favor of #133 🙂