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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow emphasising placeholders in option
directives
#10366
Allow emphasising placeholders in option
directives
#10366
Conversation
Looks good to me.
Not exactly sure what you mean here. Do you have an example? |
a60357e
to
552aeca
Compare
Thanks. Can you please mark it with a Github Approval?
Sure, happens for situation like:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments on the documentation.
An aside, perhaps the option could be named option_emphasise_placeholders
or similar? parse_detailed
doesn't tell me much about what is going on, and it isn't just the parsing that changes with this option, but the output too.
A
Thanks, I welcome the suggested changes, what about @jakobandersen? |
214665d
to
57e3fab
Compare
Well, I can imagine it can support more syntax for the future, so please let's use the more generic name |
57e3fab
to
28f97c2
Compare
I would really like to see this in |
The implementation looks reasonable, although I still don't like 'detailed_parse', as users would likely want to configure any other 'detailed parsing' independently from this. A |
28f97c2
to
1b82384
Compare
I don't have a problem with the option name suggestion, thus applied. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @marxin!
A
1b82384
to
786130c
Compare
Support parsing of "variable part" for option directives similarly to samp roles. Fixes: sphinx-doc#9965. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Signed-off-by: Martin Liska <mliska@suse.cz>
786130c
to
515c935
Compare
option_emphasise_placeholders
config value
option_emphasise_placeholders
config valueoption
directives
Thanks for your perseverance @marxin, merged. A |
Thank you guys for merging this, really helps me. |
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustement of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustment of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustment of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustment of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustment of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
If the option is enabled, the current code wrongly uses if not args: continue which skips adjustment of signode and firstname at the very of the loop. Fixes: sphinx-doc#10366.
Support parsing of "variable part" for option directives similarly
to samp roles.
Fixes: #9965.
This is a follow-up of #10001 which targeted
4.x
branch. I included @jakobandersen which were suggested in:https://github.com/jakobandersen/sphinx/tree/marxin-option_parse_variable_part.
Apart from that, I have to handle empty
args
inhandle_signature
function.