-
-
Notifications
You must be signed in to change notification settings - Fork 123
Closed
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders
Description
Is your feature request related to a problem? Please describe.
I'd like to propose a new option at the bottom of the documentation for an object with backlinks to all the places that link to that object.
I think this would make understanding libraries and navigating documentation significantly more powerful.
I'd go so far as to say this would be a "killer feature ™️".
Describe the solution you'd like
I'm sure you can design the look better than me, but I'd propose just a list of bullet points linking to both other code options that link to that object and sections of the documentation which link to it.
I assume since we're talking about square bracket links, this shouldn't be too hard? 🤞
Describe alternatives you've considered
We could do some kind of regex for this, but it would be pretty ugly.
Additional context
In https://ai.pydantic.dev/ I make very heavy use of mkdocstrings links.
pawamoy
Metadata
Metadata
Assignees
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders