IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Extract sub-functions from `Theme.__init__()`

Browse Source
This commit is contained in:
Adam Turner 2024-01-09 00:31:04 +00:00 committed by Adam Turner
parent 0ca2ddf924
commit fda9a313a6
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
sphinx/theming.py
View File

@ -49,6 +49,15 @@ def _extract_zip(filename: str, target_dir: str, /) -> None:
fp.write(archive.read(name)) fp.write(archive.read(name))
def _load_theme_conf(theme_dir: os.PathLike[str] | str) -> configparser.RawConfigParser:
c = configparser.RawConfigParser()
config_file_path = path.join(theme_dir, _THEME_CONF)
if not os.path.isfile(config_file_path):
raise ThemeError(__('theme configuration file %r not found') % config_file_path)
c.read(config_file_path, encoding='utf-8')
return c
class Theme: class Theme:
"""A Theme is a set of HTML templates and configurations. """A Theme is a set of HTML templates and configurations.
@ -69,11 +78,7 @@ class Theme:
self._theme_dir = path.join(self._root_dir, name) self._theme_dir = path.join(self._root_dir, name)
_extract_zip(theme_path, self._theme_dir) _extract_zip(theme_path, self._theme_dir)
self.config = configparser.RawConfigParser() self.config = _load_theme_conf(self._theme_dir)
config_file_path = path.join(self._theme_dir, _THEME_CONF)
if not os.path.isfile(config_file_path):
raise ThemeError(__('theme configuration file %r not found') % config_file_path)
self.config.read(config_file_path, encoding='utf-8')
try: try:
inherit = self.config.get('theme', 'inherit') inherit = self.config.get('theme', 'inherit')
@ -81,7 +86,14 @@ class Theme:
raise ThemeError(__('theme %r doesn\'t have "theme" setting') % name) from exc raise ThemeError(__('theme %r doesn\'t have "theme" setting') % name) from exc
except configparser.NoOptionError as exc: except configparser.NoOptionError as exc:
raise ThemeError(__('theme %r doesn\'t have "inherit" setting') % name) from exc raise ThemeError(__('theme %r doesn\'t have "inherit" setting') % name) from exc
self._load_ancestor_theme(inherit, theme_factory, name)
def _load_ancestor_theme(
self,
inherit: str,
theme_factory: HTMLThemeFactory,
name: str,
) -> None:
if inherit != 'none': if inherit != 'none':
try: try:
self._base = theme_factory.create(inherit) self._base = theme_factory.create(inherit)