executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
708 stars 189 forks source link

:sparkles: NEW: Emits sphinx include-read event #887

Closed sumezulike closed 3 months ago

sumezulike commented 4 months ago

Adds emission of Sphinx include-read events while processing include directives, closes #881.

include-read

If there is a better way to restrict the test to Sphinx>=7.5.2, please let me know.

welcome[bot] commented 4 months ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

sumezulike commented 4 months ago

Sorry about the noise, I forgot to test against older Python versions. Grateful for any feedback!

chrisjsewell commented 4 months ago

cheers will have a look soon

sumezulike commented 3 months ago

Any chance to take a look yet?

codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.12%. Comparing base (da1a85a) to head (d0bddee).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #887 +/- ## ========================================== + Coverage 90.10% 90.12% +0.01% ========================================== Files 24 24 Lines 3377 3383 +6 ========================================== + Hits 3043 3049 +6 Misses 334 334 ``` | [Flag](https://app.codecov.io/gh/executablebooks/MyST-Parser/pull/887/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | Coverage Δ | | |---|---|---| | [pytests](https://app.codecov.io/gh/executablebooks/MyST-Parser/pull/887/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | `90.12% <100.00%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

chrisjsewell commented 3 months ago

If there is a better way to restrict the test to Sphinx>=7.5.2, please let me know.

sorted

welcome[bot] commented 3 months ago

Congrats on your first merged pull request in this project! :tada: congrats
Thank you for contributing, we are very proud of you! :heart:

sumezulike commented 3 months ago

Awesome, thanks!