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?
::: my_package.my_module
options:
members: false
summary: true
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too