You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
2.4 KiB
70 lines
2.4 KiB
4 years ago
|
"""
|
||
|
|
sphinx.extension
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
Utilities for Sphinx extensions.
|
||
|
|
|
||
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||
|
|
:license: BSD, see LICENSE for details.
|
||
|
|
"""
|
||
|
|
|
||
|
|
from typing import Any, Dict
|
||
|
|
|
||
|
|
from sphinx.config import Config
|
||
|
|
from sphinx.errors import VersionRequirementError
|
||
|
|
from sphinx.locale import __
|
||
|
|
from sphinx.util import logging
|
||
|
|
|
||
|
|
if False:
|
||
|
|
# For type annotation
|
||
|
|
from sphinx.application import Sphinx
|
||
|
|
|
||
|
|
logger = logging.getLogger(__name__)
|
||
|
|
|
||
|
|
|
||
|
|
class Extension:
|
||
|
|
def __init__(self, name: str, module: Any, **kwargs: Any) -> None:
|
||
|
|
self.name = name
|
||
|
|
self.module = module
|
||
|
|
self.metadata = kwargs
|
||
|
|
self.version = kwargs.pop('version', 'unknown version')
|
||
|
|
|
||
|
|
# The extension supports parallel read or not. The default value
|
||
|
|
# is ``None``. It means the extension does not tell the status.
|
||
|
|
# It will be warned on parallel reading.
|
||
|
|
self.parallel_read_safe = kwargs.pop('parallel_read_safe', None)
|
||
|
|
|
||
|
|
# The extension supports parallel write or not. The default value
|
||
|
|
# is ``True``. Sphinx writes parallelly documents even if
|
||
|
|
# the extension does not tell its status.
|
||
|
|
self.parallel_write_safe = kwargs.pop('parallel_write_safe', True)
|
||
|
|
|
||
|
|
|
||
|
|
def verify_needs_extensions(app: "Sphinx", config: Config) -> None:
|
||
|
|
"""Verify the required Sphinx extensions are loaded."""
|
||
|
|
if config.needs_extensions is None:
|
||
|
|
return
|
||
|
|
|
||
|
|
for extname, reqversion in config.needs_extensions.items():
|
||
|
|
extension = app.extensions.get(extname)
|
||
|
|
if extension is None:
|
||
|
|
logger.warning(__('The %s extension is required by needs_extensions settings, '
|
||
|
|
'but it is not loaded.'), extname)
|
||
|
|
continue
|
||
|
|
|
||
|
|
if extension.version == 'unknown version' or reqversion > extension.version:
|
||
|
|
raise VersionRequirementError(__('This project needs the extension %s at least in '
|
||
|
|
'version %s and therefore cannot be built with '
|
||
|
|
'the loaded version (%s).') %
|
||
|
|
(extname, reqversion, extension.version))
|
||
|
|
|
||
|
|
|
||
|
|
def setup(app: "Sphinx") -> Dict[str, Any]:
|
||
|
|
app.connect('config-inited', verify_needs_extensions, priority=800)
|
||
|
|
|
||
|
|
return {
|
||
|
|
'version': 'builtin',
|
||
|
|
'parallel_read_safe': True,
|
||
|
|
'parallel_write_safe': True,
|
||
|
|
}
|