Extend API doc auto-linker for class bases, re-exports, and module labels#1880
Closed
Copilot wants to merge 3 commits into
Closed
Extend API doc auto-linker for class bases, re-exports, and module labels#1880Copilot wants to merge 3 commits into
Copilot wants to merge 3 commits into
Conversation
Copilot
AI
changed the title
[WIP] Fix failing GitHub Actions job pre-commit (macos-latest)
Fix macOS pre-commit failure by removing forbidden reST role markup in docstrings
Jun 1, 2026
Contributor
|
@ValbuenaVC this seems related to #1824 |
Copilot
AI
changed the title
FIX: macOS pre-commit failure by removing forbidden reST role markup in docstrings
Extend API doc auto-linker for class bases, re-exports, and module labels
Jun 1, 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 stacks on the docstring auto-linker work and closes remaining link gaps in generated API pages. It makes class inheritance and re-export entries linkable when symbols resolve in the index, while preserving plain code spans for external/unresolvable symbols.
Class
Bases:line now participates in symbol linkingrender_classnow formats bases via a dedicated_format_bases()path._rewrite_symbol_refs, so internal PyRIT bases become MyST links and external bases stay plain.## Re-exportsnow links alias and target consistently_format_reexport_alias():{module}.{alias}) so aliases resolve to their own page anchor when available;_format_reexport_target()to route targets through_rewrite_symbol_refs, linking resolvable FQNs and leaving external paths unchanged.Module frontmatter now includes a stable page label
render_modulenow emitslabel: api-<module_slug>alongsideshort_title, enabling page-level cross-reference targets.Unit coverage expanded for new link behavior