Skip to content

Commit

Permalink
docs: Switch to our own fork of sphinxcontrib-openapi
Browse files Browse the repository at this point in the history
[ upstream commit 4f893e8 ]

Sphinxcontrib-openapi relies on m2r. But m2r is unmaintained [0]. It
relies on mistune, but is not compatible with mistune versions >= 2.0
[1]. This makes it impossible to update mistune, even though there is a
CVE in the old versions of the package [2].

Switch to sphinx-mdinclude instead.

There is also m2r2, but it is not a suitable alternative because they
simply force the use of an older mistune version [3].

[0] sphinx-contrib/openapi#123
[1] miyakogi/m2r#66
[2] GHSA-fw3v-x4f2-v673
[3] CrossNox/m2r2#43

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Tobias Klauser <tobias@cilium.io>
  • Loading branch information
qmonnet authored and aditighag committed Aug 22, 2022
1 parent d364d76 commit b986246
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Documentation/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ idna==3.3
imagesize==1.3.0
Jinja2==3.0.3
jsonschema==4.4.0
# for m2r (dependency to sphinxcontrib-openapi), see https://github.com/miyakogi/m2r/issues/66
mistune<2.0.0
mistune==2.0.2
MarkupSafe==2.1.0
myst-parser==0.17.0
pyenchant==3.2.2
Expand All @@ -24,7 +23,9 @@ sphinx-autobuild==2021.3.14
# forked read the docs themez
git+https://github.com/cilium/sphinx_rtd_theme.git@v1.0
sphinxcontrib-httpdomain==1.8.0
sphinxcontrib-openapi==0.7.0
# Fork openapi until it uses something newer than unmaintained m2r
# (See git logs for details)
git+https://github.com/cilium/openapi.git@mdinclude
sphinxcontrib-spelling==7.3.2
sphinxcontrib-websupport==1.2.4
sphinx-tabs==3.3.1
Expand Down

0 comments on commit b986246

Please sign in to comment.