From 7765940f14201f03aed1038d644bd80289ad672f Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Wed, 28 Sep 2022 15:17:46 +0100 Subject: [PATCH] Ensure non-builtin extensions use the proper version --- sphinx/ext/autodoc/preserve_defaults.py | 3 ++- sphinx/ext/autodoc/typehints.py | 3 ++- sphinx/ext/autosectionlabel.py | 3 ++- sphinx/ext/duration.py | 3 ++- sphinx/ext/imgconverter.py | 3 ++- sphinx/ext/napoleon/__init__.py | 6 +++--- 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/sphinx/ext/autodoc/preserve_defaults.py b/sphinx/ext/autodoc/preserve_defaults.py index a12f42fcf1f..5ae3f3593ce 100644 --- a/sphinx/ext/autodoc/preserve_defaults.py +++ b/sphinx/ext/autodoc/preserve_defaults.py @@ -10,6 +10,7 @@ from inspect import Parameter from typing import Any, Dict, List, Optional +import sphinx from sphinx.application import Sphinx from sphinx.locale import __ from sphinx.pycode.ast import parse as ast_parse @@ -121,6 +122,6 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.connect('autodoc-before-process-signature', update_defvalue) return { - 'version': '1.0', + 'version': sphinx.__display_version__, 'parallel_read_safe': True } diff --git a/sphinx/ext/autodoc/typehints.py b/sphinx/ext/autodoc/typehints.py index 98c51e9e967..2acacfe948d 100644 --- a/sphinx/ext/autodoc/typehints.py +++ b/sphinx/ext/autodoc/typehints.py @@ -7,6 +7,7 @@ from docutils import nodes from docutils.nodes import Element +import sphinx from sphinx import addnodes from sphinx.application import Sphinx from sphinx.util import inspect, typing @@ -206,7 +207,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.connect('object-description-transform', merge_typehints) return { - 'version': 'builtin', + 'version': sphinx.__display_version__, 'parallel_read_safe': True, 'parallel_write_safe': True, } diff --git a/sphinx/ext/autosectionlabel.py b/sphinx/ext/autosectionlabel.py index ff2f695ec88..ef9249e5b0f 100644 --- a/sphinx/ext/autosectionlabel.py +++ b/sphinx/ext/autosectionlabel.py @@ -5,6 +5,7 @@ from docutils import nodes from docutils.nodes import Node +import sphinx from sphinx.application import Sphinx from sphinx.domains.std import StandardDomain from sphinx.locale import __ @@ -54,7 +55,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.connect('doctree-read', register_sections_as_label) return { - 'version': 'builtin', + 'version': sphinx.__display_version__, 'parallel_read_safe': True, 'parallel_write_safe': True, } diff --git a/sphinx/ext/duration.py b/sphinx/ext/duration.py index 94fd9077ac6..13b92fc1a7b 100644 --- a/sphinx/ext/duration.py +++ b/sphinx/ext/duration.py @@ -7,6 +7,7 @@ from docutils import nodes +import sphinx from sphinx.application import Sphinx from sphinx.domains import Domain from sphinx.locale import __ @@ -81,7 +82,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.connect('build-finished', on_build_finished) return { - 'version': 'builtin', + 'version': sphinx.__display_version__, 'parallel_read_safe': True, 'parallel_write_safe': True, } diff --git a/sphinx/ext/imgconverter.py b/sphinx/ext/imgconverter.py index 2a2260c17dd..599984c1815 100644 --- a/sphinx/ext/imgconverter.py +++ b/sphinx/ext/imgconverter.py @@ -5,6 +5,7 @@ from subprocess import PIPE, CalledProcessError from typing import Any, Dict +import sphinx from sphinx.application import Sphinx from sphinx.errors import ExtensionError from sphinx.locale import __ @@ -83,7 +84,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: app.add_config_value('image_converter_args', [], 'env') return { - 'version': 'builtin', + 'version': sphinx.__display_version__, 'parallel_read_safe': True, 'parallel_write_safe': True, } diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index bcb12416ea5..06ca8277901 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -2,7 +2,7 @@ from typing import Any, Dict, List -from sphinx import __display_version__ as __version__ +import sphinx from sphinx.application import Sphinx from sphinx.ext.napoleon.docstring import GoogleDocstring, NumpyDocstring from sphinx.util import inspect @@ -310,7 +310,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: """ if not isinstance(app, Sphinx): # probably called by tests - return {'version': __version__, 'parallel_read_safe': True} + return {'version': sphinx.__display_version__, 'parallel_read_safe': True} _patch_python_domain() @@ -320,7 +320,7 @@ def setup(app: Sphinx) -> Dict[str, Any]: for name, (default, rebuild) in Config._config_values.items(): app.add_config_value(name, default, rebuild) - return {'version': __version__, 'parallel_read_safe': True} + return {'version': sphinx.__display_version__, 'parallel_read_safe': True} def _patch_python_domain() -> None: