Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

docstring style for toc_label not working as expected #267

Closed Answered by pawamoy
ccmao1130 asked this question in Q&A
docstring style for toc_label not working as expected #267
@ccmao1130 ccmao1130
Apr 2, 2025 · 1 comments · 6 replies
Answered by pawamoy Return to top
Discussion options

ccmao1130
Apr 2, 2025

I'm trying to do this as stated in the docs:

::: path.to.module
    options:
        heading: my fancy module
        toc_label: my fancy module

however, only heading is updated to "My fancy module" but not toc_label
image
query under JSON in the nav should have been configed as "My fancy module" as well

am i using the wrong heading option maybe?
You must be logged in to vote
Answered by pawamoy Apr 3, 2025

Should be fixed in v.1.16.9.

View full answer

Replies: 1 comment · 6 replies

Comment options

pawamoy
Apr 2, 2025
Maintainer

Seems to be working fine on my end.

# title

## ::: mkdocstrings_handlers.python
    options:
        toc_label: hello
        heading: yo

test
You must be logged in to vote
6 replies
@pawamoy
Comment options

pawamoy Apr 3, 2025
Maintainer

No worries! I'm investigating in your chanchan/api-docs branch right now 🙂
@pawamoy
Comment options

pawamoy Apr 3, 2025
Maintainer

I was able to confirm the issue. Not sure what's happening yet 😅 (I've added enabled: false under mkdocs-jupyter since it takes a very long time to process notebooks).
@pawamoy
Comment options

pawamoy Apr 3, 2025
Maintainer

Yeah OK the toc label isn't used in a few places. Pushing a fix 😄
@pawamoy
Comment options

pawamoy Apr 3, 2025
Maintainer

Should be fixed in v.1.16.9.
Answer selected by pawamoy
@ccmao1130
Comment options

ccmao1130 Apr 3, 2025
Author

confirming that it works!! thank you so much for your help
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
🙏
Q&A
Labels
None yet
2 participants
@ccmao1130 @pawamoy
Morty Proxy This is a proxified and sanitized view of the page, visit original site.