- Notifications
You must be signed in to change notification settings - Fork215
Aligns directive'sblock_text
content to rST's#1048
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
kdeldycke wants to merge1 commit intoexecutablebooks:masterChoose a base branch fromkdeldycke:fix-directive-block-text
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
kdeldycke added a commit to kdeldycke/click-extra that referenced this pull requestSep 10, 2025
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
In rST, a directive's
block_text
contains the entire directive, including options and full, unparsed content.This aligns MyST parser to rST.
Context
I stumbled upon this issue while implementing my own
click:example
andclick:run
directives within my Click Extra project:https://kdeldycke.github.io/click-extra/sphinx.htmlMy implementation is trying to report, within these directives, of the absolute line in the document where a problem occured. The line number and offset calculation works perfectly in rST, butrequires some hacks to report the right one in MyST.
But even with these hacks, there is no way to retro-actively compute the absolute line number, because the directive object do not carry its unparsed content.
Example
Compare a given rST directive defined as:
Its properties are:
And for its MyST equivalent:
Limitations
Note that it is not perfect, as it is supposed to also contain:
```{name} {arguments}
first line), and```
line).But I doubt we can find a way to do it unless we introduce heavier refactor.