feature: show only the 'summary' of attributes and include defaults

[osamimi]

Sometimes you have a class / data class that has a lot of attributes (e.g. to store configuration of something)
You end up with a long list of attributes which also show up in the ToC and clutter the documentation:

With summary = true, you can get a nice table which is much denser but IMO also easier to digest:

However, there are two problems:

• As far as I can tell, you cannot hide the individual listings of the attributes and only keep the summary table.
• The summary table is missing the default value if it exits.

What I am looking for is for classes to render very similar to how functions are handled:

• a table of attributes with default values just like the table of parameters of a function
• no individual listing of attributes (same as how you can avoid that for functions with parameter_headings = False)
• the signature of __init__() to clearly show the user how to create an instance of the class (see feature: support for __init__() of pedantic/attrs classes #234)
  

[pawamoy]

Hey @osamimi, thanks again for the request!

As mentioned in #234 (comment), this is currently not possible indeed, but is tracked in these other issues:

• feat: Option to generate headings (+ ToC entries) for items in summary tables (attributes, functions/methods, classes, modules) #133
• feature: Add "value" column to tables for Attributes docstring sections mkdocstrings#533
• feat: Show member summary but not the members themselves #226

Please upvote these issues to show your interest and boost their priority!

Since it's tracked elsewhere, I'll close this issue, but I'm happy to continue the discussion here 😄