Try out mkdocstrings-python-xref
for using relative cross-references
#235
Labels
part:❓
We need to figure out which part is affected
priority:❓
We need to figure out how soon this should be addressed
type:enhancement
New feature or enhancement visitble to users
Milestone
What's needed?
We need to be able to use a shorter relative syntax when cross-referencing, for example if we are in module:
frequenz.skd.microgrid.whatever.SomeClass
and we want to refer to a method of the class, we need to type `[method()][frequenz.skd.microgrid.whatever.SomeClass.method] which is a bit insane.Proposed solution
Try out this extension: https://analog-garage.github.io/mkdocstrings-python-xref/
Additional context
The text was updated successfully, but these errors were encountered: