Skip to content

Commit

Permalink
docs: Update build dependencies (Sphinx add-ons etc.)
Browse files Browse the repository at this point in the history
Update all that we can in
Documentation/requirements-min/requirements.txt, then run the command
"make update-requirements" to update all dependencies accordingly.

There are some dependencies that we cannot update to their latest
version:

- Sphinx itself cannot be updated to 6+, because myth-parser does not
  support it.

- sphinx-tabs cannot be updated from 3.4.0 to 3.4.1, because the latter
  needs docutils 0.18 which is not currently supported by our
  sphinx_rtd_theme fork (it would need a rebase).

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
  • Loading branch information
qmonnet authored and joestringer committed Feb 27, 2023
1 parent e90df2f commit eb1338a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 34 deletions.
10 changes: 5 additions & 5 deletions Documentation/requirements-min/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Sphinx==5.1.1
Sphinx==5.3.0
sphinx-autobuild==2021.3.14

# Custom theme, forked from Read the Docs
Expand All @@ -8,14 +8,14 @@ git+https://github.com/cilium/sphinx_rtd_theme.git@v1.0#egg=sphinx-rtd-theme-cil
semver==2.13.0

# Sphinx extensions
myst-parser==0.18.0
myst-parser==0.18.1
sphinx-tabs==3.4.0
sphinx-version-warning==1.1.2
sphinxcontrib-googleanalytics==0.4
sphinxcontrib-openapi==0.8.0
sphinxcontrib-spelling==7.7.0
sphinxcontrib-openapi==0.8.1
sphinxcontrib-spelling==8.0.0
sphinxcontrib-websupport==1.2.4

# Linters
rstcheck==6.1.1
yamllint==1.27.1
yamllint==1.29.0
57 changes: 28 additions & 29 deletions Documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,69 +1,68 @@
## Auto-generated from requirements-min/requirements.txt with "make update-requirements"
Sphinx==5.1.1
Sphinx==5.3.0
sphinx-autobuild==2021.3.14

# Custom theme, forked from Read the Docs
sphinx-rtd-theme-cilium @ git+https://github.com/cilium/sphinx_rtd_theme.git@3bd69f33e7b2af2d0173fd997ec7ad21ce19ae3b
# We use semver to parse Cilium's version in the config file
semver==2.13.0
# Sphinx extensions
myst-parser==0.18.0
myst-parser==0.18.1
sphinx-tabs==3.4.0
sphinx-version-warning==1.1.2
sphinxcontrib-googleanalytics==0.4
sphinxcontrib-openapi==0.8.0
sphinxcontrib-spelling==7.6.0
sphinxcontrib-openapi==0.8.1
sphinxcontrib-spelling==8.0.0
sphinxcontrib-websupport==1.2.4
# Linters
rstcheck==6.1.1
yamllint==1.27.1
yamllint==1.29.0
## The following requirements were added by pip freeze:
alabaster==0.7.12
attrs==22.1.0
Babel==2.10.3
alabaster==0.7.13
attrs==22.2.0
Babel==2.11.0
certifi==2022.12.7
charset-normalizer==2.1.1
charset-normalizer==3.0.1
click==8.1.3
colorama==0.4.5
colorama==0.4.6
commonmark==0.9.1
deepmerge==1.0.1
deepmerge==1.1.0
docutils==0.17.1
idna==3.3
idna==3.4
imagesize==1.4.1
Jinja2==3.0.3
jsonschema==4.14.0
jsonschema==4.17.3
livereload==2.6.3
markdown-it-py==2.1.0
MarkupSafe==2.1.1
mdit-py-plugins==0.3.0
markdown-it-py==2.2.0
MarkupSafe==2.1.2
mdit-py-plugins==0.3.4
mdurl==0.1.2
mistune==2.0.4
packaging==21.3
pathspec==0.9.0
mistune==2.0.5
packaging==23.0
pathspec==0.11.0
picobox==2.2.0
pydantic==1.10.5
pyenchant==3.2.2
Pygments==2.13.0
pyparsing==3.0.9
pyrsistent==0.18.1
pytz==2022.2.1
Pygments==2.14.0
pyrsistent==0.19.3
pytz==2022.7.1
PyYAML==6.0
requests==2.28.1
requests==2.28.2
rich==12.6.0
rstcheck-core==1.0.3
shellingham==1.5.0.post1
six==1.16.0
snowballstemmer==2.2.0
sphinx_mdinclude==0.5.3
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-httpdomain==1.8.0
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-httpdomain==1.8.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
tornado==6.2
typer==0.7.0
types-docutils==0.19.1.6
typing_extensions==4.3.0
urllib3==1.26.11
typing_extensions==4.5.0
urllib3==1.26.14

0 comments on commit eb1338a

Please sign in to comment.