diff mbox series

docs: pin mistune version due to breakage

Message ID 20211206084223.448717-1-vicamo@gmail.com
State Accepted
Headers show
Series docs: pin mistune version due to breakage | expand

Commit Message

You-Sheng Yang Dec. 6, 2021, 8:42 a.m. UTC
mistune made a new release which breaks API referenced by Sphinx v4.3.1.

Closes: #442
Signed-off-by: You-Sheng Yang <vicamo@gmail.com>
---
 docs/requirements.txt | 2 ++
 1 file changed, 2 insertions(+)

Comments

Stephen Finucane Dec. 8, 2021, 2:32 p.m. UTC | #1
On Mon, 2021-12-06 at 16:42 +0800, You-Sheng Yang wrote:
> mistune made a new release which breaks API referenced by Sphinx v4.3.1.
> 
> Closes: #442
> Signed-off-by: You-Sheng Yang <vicamo@gmail.com>

Reviewed-by: Stephen Finucane <stephen@that.guru>

I was hoping to be able to fix the underlying issue myself, but the changes in
mistune are rather significant. I've applied this. Thank you!

For anyone curious, this is brought in by sphinxcontrib-openapi, which in turn
includes m2r (to convert markdown to reStructuredText), which in turn includes
the mistune library to handle the markdown parsing. Given the changes in mistune
2.0, I'm not sure how sphinxcontrib-openapi will resolve this.

Stephen
diff mbox series

Patch

diff --git a/docs/requirements.txt b/docs/requirements.txt
index f17cb78..7668b88 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -3,3 +3,5 @@  reno>=3.4.0
 sphinx-rtd-theme~=1.0
 jinja2~=3.0
 sphinxcontrib-openapi~=0.7.0
+# See https://github.com/getpatchwork/patchwork/issues/442
+mistune<2.0.0