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

Add heading and toc_label settings #236

Merged

Conversation

vancromy
Copy link
Contributor

Introduce heading and toc_label settings to allow customization of autogenerated headings and table of contents labels for modules, functions, and attributes.

closes mkdocstrings/mkdocstrings#725

@vancromy
Copy link
Contributor Author

@pawamoy Here's my first attempt. Happy to hear what your thoughts are :)

make check fails due to an api change with the new default settings. Not to sure what to do to make it pass.

make test fails due to a deprecation warning coming from the autorefs plugin.

@pawamoy
Copy link
Member

pawamoy commented Jan 29, 2025

OK let me push the spacing-related changes to main, so we can rebase and get rid of the noise in this PR 🙂

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few suggestions on the wording, otherwise LGTM! Thanks a lot!

@pawamoy pawamoy merged commit 7cabacf into mkdocstrings:main Jan 29, 2025
26 checks passed
viktorlashchuk added a commit to viktorlashchuk/mkdocstrings-python that referenced this pull request Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feature: Allow custom headings for identifiers
2 participants