Skip to content

Commit

Permalink
Ensure non-builtin extensions use the proper version
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Sep 30, 2022
1 parent 2906071 commit 7765940
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 8 deletions.
3 changes: 2 additions & 1 deletion sphinx/ext/autodoc/preserve_defaults.py
Expand Up @@ -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
Expand Down Expand Up @@ -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
}
3 changes: 2 additions & 1 deletion sphinx/ext/autodoc/typehints.py
Expand Up @@ -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
Expand Down Expand Up @@ -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,
}
3 changes: 2 additions & 1 deletion sphinx/ext/autosectionlabel.py
Expand Up @@ -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 __
Expand Down Expand Up @@ -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,
}
3 changes: 2 additions & 1 deletion sphinx/ext/duration.py
Expand Up @@ -7,6 +7,7 @@

from docutils import nodes

import sphinx
from sphinx.application import Sphinx
from sphinx.domains import Domain
from sphinx.locale import __
Expand Down Expand Up @@ -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,
}
3 changes: 2 additions & 1 deletion sphinx/ext/imgconverter.py
Expand Up @@ -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 __
Expand Down Expand Up @@ -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,
}
6 changes: 3 additions & 3 deletions sphinx/ext/napoleon/__init__.py
Expand Up @@ -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
Expand Down Expand Up @@ -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()

Expand All @@ -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:
Expand Down

0 comments on commit 7765940

Please sign in to comment.