RFE: provide support for docutils 1.18.x
#544
Labels
enhancement
New feature or request
Comments
kloczek
changed the title
docutils 1.18.x
qmonnet
added a commit
to qmonnet/cilium
that referenced
this issue
Apr 8, 2022
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 <quentin@isovalent.com>
nbusseneau
pushed a commit
to cilium/cilium
that referenced
this issue
Apr 12, 2022
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 <quentin@isovalent.com>
|
This paclage is already tested against docutils 0.18 https://github.com/executablebooks/MyST-Parser/runs/6052519350?check_suite_focus=true, and available unpinned via https://pypi.org/project/myst-docutils/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the problem/need and solution
docutils1.18.1 has been released and few modules started using it.myst-parserstill uses older versionMyST-Parser/setup.cfg
Lines 39 to 40 in dc45a1f
sphinxalready started working on newdocutilssupport sphinx-doc/sphinx#9777Guide for implementation
No response
Tasks and updates
No response
The text was updated successfully, but these errors were encountered: