Repository navigation
✨ Parse directive source without a directive schema - #1233
Open
adamtheturtle wants to merge 1 commit into
Open
adamtheturtle wants to merge 1 commit into
adamtheturtle wants to merge 1 commit into
Conversation
This was referenced Nov 14, 2026
This branch has not been deployed
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.
Source-analysis tools currently have to define a placeholder docutils directive and custom
option_specjust to extract arbitrary options and body offsets. Allowparse_directive_text(None, first_line, content)to parse the syntax without a directive schema, retaining string values and syntax diagnostics.Make
DirectiveParsingResultgeneric and type the schema-free overload asDirectiveParsingResult[str]. Calls with a directive class or full-YAML mode keep support for arbitrary converted values. Existing directive validation and rendering behavior is unchanged.Closes #1232.
This removes the abstract directive, custom option mapping and Pylint/Pyright suppressions from the downstream integration in adamtheturtle/sybil-extras#1369.
Validation:
tox -e py311-sphinx9: 1,575 passed, 11 skipped.tox -e mypy,ruff-check,ruff-fmtandpre-commit run --all-files: passed.tox -e docs-clean -- -T: passed with warnings treated as errors.