diff options
Diffstat (limited to 'sphinx/extension.py')
| -rw-r--r-- | sphinx/extension.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/sphinx/extension.py b/sphinx/extension.py index 356b4ab9d..2a984f5b4 100644 --- a/sphinx/extension.py +++ b/sphinx/extension.py @@ -34,7 +34,14 @@ class Extension: def verify_needs_extensions(app: "Sphinx", config: Config) -> None: - """Verify the required Sphinx extensions are loaded.""" + """Check that extensions mentioned in :confval:`needs_extensions` satisfy the version + requirement, and warn if an extension is not loaded. + + Warns if an extension in :confval:`needs_extension` is not loaded. + + :raises VersionRequirementError: if the version of an extension in + :confval:`needs_extension` is unknown or older than the required version. + """ if config.needs_extensions is None: return |