openapi icon indicating copy to clipboard operation
openapi copied to clipboard

m2r haven't been updated in years

Open cblegare opened this issue 3 years ago • 6 comments

With the recent major release Mistune (2.0), leading to breakage (see https://github.com/miyakogi/m2r/issues/66), I suggest to switch to m2r2: https://github.com/CrossNox/m2r2

cblegare avatar Dec 13 '21 17:12 cblegare

~~Or, alternatively, https://myst-parser.readthedocs.io/~~ (retract that, there is no such functionality)

astrojuanlu avatar Dec 14 '21 16:12 astrojuanlu

Using m2r2 currently does not help either: It also pins mistune to version 0.8.4 in its setup.py, see https://github.com/CrossNox/m2r2/blob/development/setup.py#L24 (at least at the time when I wrote this comment.)

icemac avatar Apr 19 '22 08:04 icemac

In https://github.com/miyakogi/m2r/issues/60#issuecomment-1103246787 sphinx-mdinclude is suggested as an m2r fork which could solve the problem. It uses mistune >= 2, see https://github.com/jreese/sphinx-mdinclude/blob/main/pyproject.toml#L18.

icemac avatar Apr 20 '22 05:04 icemac

@qmonnet just saw that you fixed the issue in a branch of your fork. Any chance you would be willing to maintain that fork any further? would be highly appreciated to have a solution publicly available that does not rely on pinning the mistune version

jeriox avatar Aug 30 '22 21:08 jeriox

Any chance you would be willing to maintain that fork any further?

Sorry, I don't have the expertise of the time for that (the changes I contributed are pretty minor). But I was planning to submit the changes as a PR to the current repository. It was pending some other fix which was addressed last week, now I just need to find a moment to get to it and create the PR.

qmonnet avatar Aug 31 '22 09:08 qmonnet

Any chance you would be willing to maintain that fork any further?

Sorry, I don't have the expertise of the time for that (the changes I contributed are pretty minor). But I was planning to submit the changes as a PR to the current repository. It was pending some other fix which was addressed last week, now I just need to find a moment to get to it and create the PR.

sad to hear, but understandable. Let's see if something happens to your PR as this repo seems to be untouched for two years...

jeriox avatar Aug 31 '22 11:08 jeriox

@jeriox Just for your information, the PR has been merged, and a new tag was created a few days ago, in case this issue is still relevant to you.

qmonnet avatar Jan 16 '23 13:01 qmonnet

@qmonnet already got the notification that this issue has been closed, was happy to see it. Thanks for the PR and the ping!

jeriox avatar Jan 17 '23 08:01 jeriox