Fix duplicate mkdocs autorefs targets in generated reference pages#176
Merged
Conversation
Precompute the full set of generated reference pages and use it when deciding which package re-exports to inline under "Exported API". This avoids rendering symbols twice when they already have their own module or package reference page, which was causing mkdocs_autorefs warnings like: - Multiple primary URLs found for qten.abstracts.Convertible.convert - Multiple primary URLs found for qten.precision.set_precision Behavior after this change: - Re-exports with their own generated reference page are skipped on the parent package page - Re-exports without their own page are still rendered under "Exported API" Also verified the docs build succeeds with properdocs.yml and that no package re-export coverage is lost by the dedup logic.
Alphaharrius
added
bug
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
2 participants
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.
See #174.
Summary
Precompute the full set of generated reference pages and use it when deciding which package re-exports to inline under "Exported API".
This avoids rendering symbols twice when they already have their own module or package reference page, which was causing mkdocs_autorefs warnings like:
Behavior after this change:
Also verified the docs build succeeds with properdocs.yml and that no package re-export coverage is lost by the dedup logic.