-
Notifications
You must be signed in to change notification settings - Fork 8
Enable scoped references in mkdocs #472
Copy link
Copy link
Open
Labels
part:mkdocsAffects the configuration of mkdocsAffects the configuration of mkdocspart:templateAffects the cookiecutter template filesAffects the cookiecutter template filestype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
Milestone
Metadata
Metadata
Assignees
Labels
part:mkdocsAffects the configuration of mkdocsAffects the configuration of mkdocspart:templateAffects the cookiecutter template filesAffects the cookiecutter template filestype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
What's needed?
In mkdocstrings-python 1.19, finally we can write relative and scoped references in docs, avoiding the huge strings to do cross references:
Now can be something like:
Proposed solution
Depend on 1.19 and enable the new options in the templates and this project:
Use cases
No response
Alternatives and workarounds
No response
Additional context
Limitations of scoped cross-refs: