← 返回首页
Fix sphinx deprecation warning about env.note_versionchange() by pablogsal · Pull Request #13236 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Fix sphinx deprecation warning about env.note_versionchange()#13236

Merged
pablogsal merged 1 commit into
python:masterfrom
pablogsal:sphinx_warning
May 10, 2019
Merged

Fix sphinx deprecation warning about env.note_versionchange()#13236
pablogsal merged 1 commit into
python:masterfrom
pablogsal:sphinx_warning

Conversation

pablogsal commented May 10, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

The warning:

/home/pablogsal/github/cpython/Doc/tools/extensions/pyspecific.py:274: RemovedInSphinx30Warning: env.note_versionchange() is deprecated. Please use ChangeSetDomain.note_changeset() instead. env.note_versionchange('deprecated', version[0], node, self.lineno)

pablogsal self-assigned this May 10, 2019
pablogsal merged commit 960bb88 into python:master May 10, 2019
pablogsal deleted the sphinx_warning branch May 10, 2019 21:58
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 2, 2020
Update python36 to version 3.6.12 / rev 4 via SR 852415 …
c38825c
https://build.opensuse.org/request/show/852415 by user mcepl + dimstar_suse - Add CVE-2020-27619-no-eval-http-content.patch fixing CVE-2020-27619 (bsc#1178009), where Lib/test/multibytecodec_support calls eval() on content retrieved via HTTP. - Add patch sphnix-update-removed-function.patch to no longer call a now removed function (gh#python/cpython#13236). As a consequence, no longer pin Sphinx version. - Pin Sphinx version to fix doc subpackage - Change setuptools and pip version numbers according to new wheels - Add ignore_pip_deprec_warn.patch to switch of persistently failing test. - Replace bundled wheels for pip and setuptools with the updated ones (bsc#1176262 CVE-2019-20916). - Handful of changes to make python36 compatible with SLE15 and SLE12 (jsc#ECO-2799, jsc#SLE-13738) - Rebase bpo23395-PyErr_SetInterrupt-signal.patch - Fix build with RP

mcepl commented Dec 5, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

@pablogsal I think this is suboptimal solution, because it makes Python dependent on the latest version of Sphinx unnecessarily. It is very easy to make something like this:

--- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -231,10 +231,14 @@ class DeprecatedRemoved(Directive): translatable=False) node.append(para) env = self.state.document.settings.env - env.note_versionchange('deprecated', version[0], node, self.lineno) + # new method + if hasattr(env, 'get_domain'): + env.get_domain('changeset').note_changeset(node) + # deprecated pre-Sphinx-2 method + else: + env.note_versionchange('deprecated', version[0], node, self.lineno) return [node] + messages - # Support for including Misc/NEWS issue_re = re.compile('(?:[Ii]ssue #|bpo-)([0-9]+)')

pablogsal commented Dec 5, 2020

Copy link
Copy Markdown
Member Author

@pablogsal I think this is suboptimal solution, because it makes Python dependent on the latest version of Sphinx unnecessarily. It is very easy to make something like this:

--- a/Doc/tools/extensions/pyspecific.py +++ b/Doc/tools/extensions/pyspecific.py @@ -231,10 +231,14 @@ class DeprecatedRemoved(Directive): translatable=False) node.append(para) env = self.state.document.settings.env - env.note_versionchange('deprecated', version[0], node, self.lineno) + # new method + if hasattr(env, 'get_domain'): + env.get_domain('changeset').note_changeset(node) + # deprecated pre-Sphinx-2 method + else: + env.note_versionchange('deprecated', version[0], node, self.lineno) return [node] + messages - # Support for including Misc/NEWS issue_re = re.compile('(?:[Ii]ssue #|bpo-)([0-9]+)')

Thanks for pointing that out! Would you like to submit a PR?

mcepl mentioned this pull request Dec 5, 2020
Merged
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 7, 2020
Update python36 to version 3.6.12 / rev 5 via SR 853314 …
407bdf7
https://build.opensuse.org/request/show/853314 by user mcepl + dimstar_suse - (bsc#1179630) Update sphinx-update-removed-function.patch to work with all versions of Sphinx (not binding the Python documentation build to the latest verison of Sphinx). Updated version mentioned on gh#python/cpython#13236. - Add CVE-2020-27619-no-eval-http-content.patch fixing CVE-2020-27619 (bsc#1178009), where Lib/test/multibytecodec_support calls eval() on content retrieved via HTTP. - Add patch sphinx-update-removed-function.patch to no longer call a now removed function (gh#python/cpython#13236). As a consequence, no longer pin Sphinx version. - Pin Sphinx version to fix doc subpackage - Change setuptools and pip version numbers according to new wheels - Add ignore_pip_deprec_warn.patch to switch of persistently failing test. - Replace bundled wheels for pip and se
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 7, 2020
Update python39 to version 3.9.0 / rev 8 via SR 853313 …
e88bbbb
https://build.opensuse.org/request/show/853313 by user mcepl + dimstar_suse - Add patch sphinx-update-removed-function.patch to no longer call a now removed function and to make documentation build independent of the Sphinx version (bsc#1179630, gh#python/cpython#13236).
pablogsal pushed a commit that referenced this pull request Dec 7, 2020
bpo-42579: Make workaround for various versions of Sphinx more robust (… …
b63a620
…GH-23662) The solution in gh##13236 is too strict because it effectively requires the use of Sphinx >= 2.0. It is not too difficult to make the same solution more robust so it works with all normal versions of Sphinx.
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 8, 2020
Update python36 to version 3.6.12 / rev 5 via SR 853314 …
6057cc7
https://build.opensuse.org/request/show/853314 by user mcepl + dimstar_suse - (bsc#1179630) Update sphinx-update-removed-function.patch to work with all versions of Sphinx (not binding the Python documentation build to the latest verison of Sphinx). Updated version mentioned on gh#python/cpython#13236. - Add CVE-2020-27619-no-eval-http-content.patch fixing CVE-2020-27619 (bsc#1178009), where Lib/test/multibytecodec_support calls eval() on content retrieved via HTTP. - Add patch sphinx-update-removed-function.patch to no longer call a now removed function (gh#python/cpython#13236). As a consequence, no longer pin Sphinx version. - Pin Sphinx version to fix doc subpackage - Change setuptools and pip version numbers according to new wheels - Add ignore_pip_deprec_warn.patch to switch of persistently failing test. - Replace bundled wheels for pip and se
bmwiedemann pushed a commit to bmwiedemann/openSUSE that referenced this pull request Dec 18, 2020
Update python36 to version 3.6.12 / rev 8 via SR 856737 …
d9a18cf
https://build.opensuse.org/request/show/856737 by user mcepl + dimstar_suse - Adjust sphinx-update-removed-function.patch - (bsc#1179630) Update sphinx-update-removed-function.patch to work with all versions of Sphinx (not binding the Python documentation build to the latest verison of Sphinx). Updated version mentioned on gh#python/cpython#13236. - Add CVE-2020-27619-no-eval-http-content.patch fixing CVE-2020-27619 (bsc#1178009), where Lib/test/multibytecodec_support calls eval() on content retrieved via HTTP. - Add patch sphinx-update-removed-function.patch to no longer call a now removed function (gh#python/cpython#13236). As a consequence, no longer pin Sphinx version. - Pin Sphinx version to fix doc subpackage - Change setuptools and pip version numbers according to new wheels (bsc#1179756). - Add ignore_pip_deprec_warn.patch to switch of persi
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
bpo-42579: Make workaround for various versions of Sphinx more robust (… …
40a3299
…pythonGH-23662) The solution in gh#python#13236 is too strict because it effectively requires the use of Sphinx >= 2.0. It is not too difficult to make the same solution more robust so it works with all normal versions of Sphinx.
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

pablogsal

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Footer

© 2026 GitHub, Inc.