FIX: Fixing Myst ToC#2144
Merged
Merged
Conversation
Remove stale 'api/pyrit_identifiers.md' reference from doc/myst.yml. The top-level pyrit/identifiers module was removed in microsoft#2111 (identifiers now live under pyrit/models/identifiers/), so the API generator no longer produces pyrit_identifiers.md, causing doc validation to fail. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
myst check is failing because it's checking against main. But this should fix that failure |
jsong468
approved these changes
Jul 9, 2026
romanlutz
approved these changes
Jul 9, 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
3 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.
Description
Fixes a general documentation-validation failure in CI:
Root cause
PR #2111 removed the top-level
pyrit/identifiers/deprecation-shim module. Those identifier types now live underpyrit/models/identifiers/and are documented as part ofpyrit_models.md. As a result the API generator (build_scripts/gen_api_md.py) no longer emitsdoc/api/pyrit_identifiers.md, butdoc/myst.ymlstill referenced it in the API Reference TOC, sobuild_scripts/validate_docs.pyfailed.Fix
Remove the stale
api/pyrit_identifiers.mdentry fromdoc/myst.yml.Verification
python build_scripts/validate_docs.py→ all validations pass (156 file references OK, no orphaned files).pre-commit(incl. Validate Documentation Structure) passes on the change.Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com