From 96a3b884f62b745c481259e201ecfcb49120586a Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 22 Aug 2023 21:04:49 -0500 Subject: [PATCH 1/2] Unconditionally use sphinx_rtd_theme when building docs This is a speculative fix for the latest build failure on RTD, https://readthedocs.org/projects/circuitpython/builds/21689508/ which appears to be due to a change in RTD's "conf.py.tmpl" https://github.com/readthedocs/readthedocs.org/commit/2066e3486a25bbd76431e1f8c20be3da0043f03a ``` Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/circuitpython/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 358, in eval_config_file exec(code, namespace) # NoQA: S102 ^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/circuitpython/checkouts/latest/conf.py", line 600, in 'html_theme': html_theme, ^^^^^^^^^^ NameError: name 'html_theme' is not defined ``` --- conf.py | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/conf.py b/conf.py index e14c6ace83..dd2de7b899 100644 --- a/conf.py +++ b/conf.py @@ -265,19 +265,9 @@ rst_epilog = """ # -- Options for HTML output ---------------------------------------------- -# on_rtd is whether we are on readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] - except: - html_theme = 'default' - html_theme_path = ['.'] -else: - html_theme_path = ['.'] +import sphinx_rtd_theme +html_theme = 'sphinx_rtd_theme' +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From 9064c6e7cb163e0b310827285c2dbe56076db8da Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Wed, 23 Aug 2023 07:22:28 -0500 Subject: [PATCH 2/2] ci_set_matrix: changing conf.py should not rebuild all boards --- tools/ci_set_matrix.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/ci_set_matrix.py b/tools/ci_set_matrix.py index f549b6f6f1..51876d9b2b 100755 --- a/tools/ci_set_matrix.py +++ b/tools/ci_set_matrix.py @@ -45,6 +45,7 @@ from shared_bindings_matrix import ( # Files that never influence board builds IGNORE_BOARD = { ".devcontainer", + "conf.py", "docs", "tests", "tools/ci_changes_per_commit.py",