Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unconditionally use sphinx_rtd_theme when building docs #8322

Merged
merged 1 commit into from
Aug 23, 2023

Conversation

jepler
Copy link
Member

@jepler jepler commented Aug 23, 2023

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": readthedocs/readthedocs.org@2066e34

failure message says in part:

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 <module>
    'html_theme': html_theme,
                  ^^^^^^^^^^
NameError: name 'html_theme' is not defined

which clearly WOULD happen when the else branch was taken, except that the conf.py changes previously performed by rtd fixed the problem magically.

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"

readthedocs/readthedocs.org@2066e34

```
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 <module>
    'html_theme': html_theme,
                  ^^^^^^^^^^
NameError: name 'html_theme' is not defined
```
@jepler jepler requested a review from dhalbert August 23, 2023 02:07
Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's try it

@dhalbert dhalbert merged commit 92e991d into adafruit:8.2.x Aug 23, 2023
94 of 432 checks passed
@jepler
Copy link
Member Author

jepler commented Aug 23, 2023

it built 🎉

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants