Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Show member summary but not the members themselves #226

Open
pawamoy opened this issue Jan 15, 2025 Discussed in #224 · 0 comments
Open

feat: Show member summary but not the members themselves #226

pawamoy opened this issue Jan 15, 2025 Discussed in #224 · 0 comments
Assignees
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Member

pawamoy commented Jan 15, 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 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

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.

Fund with Polar
@pawamoy pawamoy added feature New feature or request insiders Candidate for Insiders fund Issue priority can be boosted labels Jan 15, 2025
@pawamoy pawamoy self-assigned this Jan 15, 2025
@pawamoy 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

1 participant