forked from cilium/cilium
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the version for Sphinx. This includes: - Switching to the latest release of Sphinx: v4.5.0 - Upgrading a few related dependencies (docutils, sphinx-tabs, sphinxcontrib-httpdomain) - Updating some deprecated APIs: - app.add_javascript() -> app.add_js_file(), - app.stylesheet() -> app.add_css_file() - Switching to a new parser for Markdown. MyST is now the recommended way to include Markdown files [0]. As a consequence, we drop the dependency for the former parser, recommonmark. Add suppression of some related warnings. - Update the script for running spellchecks. The spellchecking extension has changed the way it reports mistakes, using a global warning to tell how many mistakes were found, and writing the reports to several files, one per source file containing mistakes. This makes it harder to retrieve the list of mistakes from console output, as we can no longer dissociate them from other warnings. Let's instead process the various files containing the reports. Since we touch the script, remove filtering expressions which do not seem to catch any existing warning. Notes: - Sphinx 4.5.0 does not recognise interpreted text as glossary terms, as older versions would do. But all glossary terms have been marked as such in a previous commit. - MyST needs the path to the source Markdown files for creating links (not the generated HTML); The files generated for cmdref have all been updated accordingly in a previous commit. - Docutils cannot be updated to the latest version: there is at least MyST which is not compatible with version 0.18.x [1]. [0] https://www.sphinx-doc.org/en/master/usage/markdown.html [1] executablebooks/MyST-Parser#544 Signed-off-by: Quentin Monnet <[email protected]>
- Loading branch information
Showing
3 changed files
with
25 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,31 +2,31 @@ alabaster==0.7.12 | |
Babel==2.9.1 | ||
certifi==2018.10.15 | ||
chardet==3.0.4 | ||
docutils==0.14 | ||
docutils==0.17 | ||
idna==2.7 | ||
imagesize==1.1.0 | ||
Jinja2==2.11.3 | ||
jsonschema==2.6.0 | ||
MarkupSafe==1.1.1 | ||
myst-parser==0.17.0 | ||
pyenchant==2.0.0 | ||
Pygments==2.7.4 | ||
pytz==2018.7 | ||
PyYAML==5.4 | ||
recommonmark==0.4.0 | ||
requests==2.25.1 | ||
semver==2.9.0 | ||
six==1.15.0 | ||
snowballstemmer==1.2.1 | ||
Sphinx==1.8.1 | ||
Sphinx==4.5.0 | ||
sphinx-autobuild==0.7.1 | ||
# forked read the docs themez | ||
git+https://github.com/cilium/[email protected]; platform_machine != "aarch64" | ||
sphinx-rtd-theme==0.2.4; platform_machine == "aarch64" | ||
sphinxcontrib-httpdomain==1.7.0 | ||
sphinxcontrib-httpdomain==1.8.0 | ||
sphinxcontrib-openapi==0.3.2 | ||
sphinxcontrib-spelling==4.2.1 | ||
sphinxcontrib-websupport==1.1.0 | ||
sphinx-tabs==1.1.13 | ||
sphinx-tabs==3.3.1 | ||
sphinx-version-warning==1.1.2 | ||
typing==3.6.6 | ||
urllib3==1.26.5 | ||
|