Skip to content

Add subs support for inline code snippets #1705

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

Merged
merged 5 commits into from
Aug 8, 2025
Merged

Conversation

theletterf
Copy link
Contributor

@theletterf theletterf commented Aug 8, 2025

Fixes #1308

This adds the following notation for inline code subs:

{subs}`This is an inline snippet with {{version.stack}} a sub`

@theletterf theletterf requested review from a team as code owners August 8, 2025 10:47
@theletterf theletterf self-assigned this Aug 8, 2025
@theletterf theletterf added the fix label Aug 8, 2025
Copy link

github-actions bot commented Aug 8, 2025

🔍 Preview links for changed docs

Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This this is technically a myst role syntax ensure we use our RoleParser<>

https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html#roles-an-in-line-extension-point

Given its syntax role{args} we should name to role more as a noun/verb.

sub{args} ?

@theletterf
Copy link
Contributor Author

@Mpdreamz Set this as a {subs} role, WDYT?

@theletterf theletterf requested a review from Mpdreamz August 8, 2025 11:17
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it!

@Mpdreamz Mpdreamz merged commit 66a7abb into main Aug 8, 2025
19 checks passed
@Mpdreamz Mpdreamz deleted the add-subs-inline-code branch August 8, 2025 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Support substitutions in inline code
2 participants