executablebooks / sphinx-exercise

A Sphinx extension for producing exercise and solution directives.
https://ebp-sphinx-exercise.readthedocs.io
MIT License
18 stars 6 forks source link

ENH: Compatibility with docutils>=0.18 (from support with sphinx>=5) #60

Closed AakashGfude closed 1 year ago

AakashGfude commented 1 year ago

This PR updates sphinx-exercise to support sphinx5 and by proxy docutils>=0.18.<0.19

fixes https://github.com/executablebooks/sphinx-exercise/issues/59

mmcky commented 1 year ago

Let's update the requirements so we test against sphinx4 and sphinx5

mmcky commented 1 year ago

@AakashGfude I don't think we need to work on supporting python=3.7 as it is not receiving security updates in ~3 months and will be deprecated anyway.

codecov-commenter commented 1 year ago

Codecov Report

Base: 94.10% // Head: 94.25% // Increases project coverage by +0.15% :tada:

Coverage data is based on head (065b9fd) compared to base (f555d72). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #60 +/- ## ========================================== + Coverage 94.10% 94.25% +0.15% ========================================== Files 7 7 Lines 628 627 -1 ========================================== Hits 591 591 + Misses 37 36 -1 ``` | Flag | Coverage Δ | | |---|---|---| | pytests | `94.25% <ø> (+0.15%)` | :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. | [Impacted Files](https://codecov.io/gh/executablebooks/sphinx-exercise/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | Coverage Δ | | |---|---|---| | [sphinx\_exercise/\_\_init\_\_.py](https://codecov.io/gh/executablebooks/sphinx-exercise/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4ZXJjaXNlL19faW5pdF9fLnB5) | `95.06% <ø> (ø)` | | | [sphinx\_exercise/directive.py](https://codecov.io/gh/executablebooks/sphinx-exercise/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4ZXJjaXNlL2RpcmVjdGl2ZS5weQ==) | `97.14% <ø> (ø)` | | | [sphinx\_exercise/transforms.py](https://codecov.io/gh/executablebooks/sphinx-exercise/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4ZXJjaXNlL3RyYW5zZm9ybXMucHk=) | `97.32% <ø> (ø)` | | | [sphinx\_exercise/utils.py](https://codecov.io/gh/executablebooks/sphinx-exercise/pull/60?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4ZXJjaXNlL3V0aWxzLnB5) | `60.00% <0.00%> (+3.75%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

mmcky commented 1 year ago

@AakashGfude can you do a final review and let me know if you think we need any further testing before putting together a new release

AakashGfude commented 1 year ago

@mmcky this looks good to me. I think we can go ahead and merge.

AakashGfude commented 1 year ago

@mmcky I think we still need some testing for sphinx5. give me a few moments,

AakashGfude commented 1 year ago

Looks good to me now @mmcky , should we cut a release?