Skip to content

Emit include-read event #881

@sumezulike

Description

@sumezulike

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions