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

feature: No-TOC YAML option #672

Open
pawamoy opened this issue May 25, 2024 · 0 comments
Open

feature: No-TOC YAML option #672

pawamoy opened this issue May 25, 2024 · 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 May 25, 2024

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

Sometimes we want to render an object's docs but not include its headings into the ToC, because we render it for documentation purposes (examples), and we don't need the entries in the ToC.

Describe the solution you'd like

An option to prevent adding any generated heading to the ToC.

Describe alternatives you've considered

In mkdocstrings-python's docs, we do this:

```md exec="on"
::: package.get_version
    options:
      heading_level: 3
      parameter_headings: true
      docstring_section_style: list
```

This effectively converts the Markdown in a sub-layer, preventing propagation of headings.

Additional context

/

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy pawamoy added the feature New feature or request label May 25, 2024
@pawamoy pawamoy self-assigned this May 25, 2024
@pawamoy pawamoy added fund Issue priority can be boosted insiders Candidate for Insiders labels Oct 22, 2024
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