Skip to content
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

Emit include-read event #881

Closed
sumezulike opened this issue Mar 3, 2024 · 1 comment · Fixed by #887
Closed

Emit include-read event #881

sumezulike opened this issue Mar 3, 2024 · 1 comment · Fixed by #887
Labels
enhancement New feature or request

Comments

@sumezulike
Copy link
Contributor

Describe the feature you'd like to request

Sphinx added an include-read event with 7.2.5 that is emitted after an include directive is processed.
It would be helpful to implement that for the MyST include directive too.

Describe the solution you'd like

The "include-read" event could be emitted immediately after the file is read like Sphinx does it.

Maybe adding this in MockIncludeDirective is good enough?

# Emit the "include-read" event
arg = [file_content]
self.renderer.sphinx_env.app.events.emit("include-read", path, self.renderer.sphinx_env.docname, arg)
file_content = arg[0]

Describe alternatives you've considered

No response

@sumezulike sumezulike added the enhancement New feature or request label Mar 3, 2024
Copy link

welcome bot commented Mar 3, 2024

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant