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

Try out mkdocstrings-python-xref for using relative cross-references #235

Open
llucax opened this issue Feb 28, 2024 · 0 comments
Open

Try out mkdocstrings-python-xref for using relative cross-references #235

llucax opened this issue Feb 28, 2024 · 0 comments
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

Comments

@llucax
Copy link
Contributor

llucax commented Feb 28, 2024

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

@llucax llucax added 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 labels Feb 28, 2024
@llucax llucax added this to the v0.10.0 milestone Feb 28, 2024
@llucax llucax modified the milestones: v0.10.0, v0.11.0 Jul 10, 2024
@llucax llucax modified the milestones: v0.11.0, v0.12.0 Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant