Repository navigation
Use absolute cross-references in docstrings - #323
Merged
Merged
Conversation
Since mkdocstrings-python 2.0.9, relative cross-references are expanded from the path where an object is defined, not where it is documented. All our public symbols are defined in private modules and re-exported from `frequenz.dispatch`, so 6 of the current references can't be found anymore and the strict documentation build fails, blocking the bump. Counting the dots from the private module would fix the build, but it ties the references to the private module layout, breaks them on older mkdocstrings-python versions, and can make references to inherited members silently link to the wrong class. Relative references are also hard to read in an IDE, and only work in projects rendering our inherited docstrings if they enable `relative_crossrefs` too. All relative references are converted to absolute references to the public path of their target, which don't depend on any of that. The targets were taken from what mkdocstrings-python 2.0.8 expanded each reference to, and the built documentation has the same links as before, with both mkdocstrings-python 2.0.8 and 2.0.10. The references in the docstring of the private `DispatchScheduler.new_running_state_event_receiver()`, which is not rendered, are converted too, pointing to the public symbols they were meant for. Some paragraphs are rewrapped to fit the longer references. See frequenz-floss/frequenz-repo-config-python#655 for details. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
No docstring uses relative cross-references anymore, so the option is removed to stop new ones from being added. Absolute references to public paths are the convention from now on. See frequenz-floss/frequenz-repo-config-python#655 for details. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
llucax
marked this pull request as ready for review
November 4, 2026 12:41
llucax
requested review from
Marenz and
ela-kotulska-frequenz
and removed request for
a team
November 4, 2026 12:41
llucax
enabled auto-merge
November 4, 2026 12:41
Marenz
approved these changes
Nov 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This converts every relative cross-reference in the docstrings to an absolute reference to the target's public path, and removes
relative_crossrefs: truefrommkdocs.yml, as proposed in frequenz-floss/frequenz-repo-config-python#655. It's the same change as frequenz-floss/frequenz-core-python#207 and frequenz-floss/frequenz-channels-python#566.It unblocks #321: with mkdocstrings-python 2.0.9 and later, 6 references in
Dispatchercan't be found anymore and the strict docs build fails. Now the docs build cleanly with both 2.0.8 and 2.0.10, with the same links as before.