Skip to content

feature: Back links! #723

@samuelcolvin

Description

@samuelcolvin

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.

Metadata

Metadata

Assignees

Labels

featureNew feature or requestinsidersCandidate for Insiders

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions