Skip to content

Commit

Permalink
Raise a useful error if theme.conf doesn't exist (#11671)
Browse files Browse the repository at this point in the history
  • Loading branch information
vsajip committed Sep 14, 2023
1 parent 655bd15 commit f0c25a0
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Features added
Bugs fixed
----------

* #11668: Raise a useful error when ``theme.conf`` is missing.
Patch by Vinay Sajip.

Testing
-------

Expand Down
5 changes: 4 additions & 1 deletion sphinx/theming.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,10 @@ def __init__(self, name: str, theme_path: str, factory: HTMLThemeFactory) -> Non
extract_zip(theme_path, self.themedir)

self.config = configparser.RawConfigParser()
self.config.read(path.join(self.themedir, THEMECONF), encoding='utf-8')
config_file_path = path.join(self.themedir, THEMECONF)
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:
inherit = self.config.get('theme', 'inherit')
Expand Down
9 changes: 8 additions & 1 deletion tests/test_theming.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import pytest

import sphinx.builders.html
from sphinx.theming import ThemeError
from sphinx.theming import Theme, ThemeError


@pytest.mark.sphinx(
Expand Down Expand Up @@ -62,6 +62,13 @@ def test_theme_api(app, status, warning):
assert not os.path.exists(themedir)


def test_nonexistent_theme_conf(tmp_path):
# Check that error occurs with a non-existent theme.conf
# (https://github.com/sphinx-doc/sphinx/issues/11668)
with pytest.raises(ThemeError):
Theme('dummy', str(tmp_path), None)


@pytest.mark.sphinx(testroot='double-inheriting-theme')
def test_double_inheriting_theme(app, status, warning):
assert app.builder.theme.name == 'base_theme2'
Expand Down

0 comments on commit f0c25a0

Please sign in to comment.