You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Originally posted by mbraakhekke January 12, 2025
I have a module with a bunch of classes. I would like to have a separate page for each class with the respective docs. Additionally, I'd like to have a overview page for the module with a summary of the classes. I can generate the ref pages with a script. However, I can't get mkdocstrings to generate a summary for the module overview page. Below the ref .md. file for the module. I have to set members: false to prevent rendering the classes on the overview page. However, then the summary also doesn't get rendered. Is there a solution for this?
pawamoy
changed the title
feat: Render module member summary if member docs are on different pages
feat: Show member summary but not the members themselves
Jan 17, 2025
Discussed in #224
Originally posted by mbraakhekke January 12, 2025
I have a module with a bunch of classes. I would like to have a separate page for each class with the respective docs. Additionally, I'd like to have a overview page for the module with a summary of the classes. I can generate the ref pages with a script. However, I can't get
mkdocstrings
to generate a summary for the module overview page. Below the ref.md
. file for the module. I have to setmembers: false
to prevent rendering the classes on the overview page. However, then the summary also doesn't get rendered. Is there a solution for this?This issue was labeled with the
fund
label. The following section is automatically added by Polar.Boost priority in our backlog through Polar's "issue funding". Issues linked to monthly sponsorships of $50 or more (author, upvoters) are already prioritized, see how we manage our backlog.
The text was updated successfully, but these errors were encountered: