Skip to content

Fix docs#9755

Merged
bmw merged 3 commits intomasterfrom
fix-docs
Aug 25, 2023
Merged

Fix docs#9755
bmw merged 3 commits intomasterfrom
fix-docs

Conversation

@bmw
Copy link
Copy Markdown
Member

@bmw bmw commented Aug 25, 2023

Our docs builds failed last night, presumably because #9754 updated sphinx_rtd_theme which changed some unknown thing.

Looking into it, our usage of this project was very unconventional. Following the code comment I deleted in this PR to https://docs.readthedocs.io/en/stable/faq.html#i-want-to-use-the-read-the-docs-theme-locally, simple instructions are given to put the following in your conf.py file:

extensions = [
    ...
    'sphinx_rtd_theme',
]

html_theme = "sphinx_rtd_theme"

I did this instead of the more complicated logic we were using and all builds passed locally. I also triggered a build on readthedocs with these changes which also passed. See https://readthedocs.org/projects/certbot-dns-cloudflare/builds/21722746/.

@bmw bmw mentioned this pull request Aug 25, 2023
@zoracon zoracon self-requested a review August 25, 2023 19:16
@adferrand
Copy link
Copy Markdown
Collaborator

I guess the old code was coming from old instructions that are not relevant anymore nowadays ?

Anyway this looks way more simple and less prone to unexpected side effects in the future.

@bmw bmw merged commit 579b39d into master Aug 25, 2023
@bmw bmw deleted the fix-docs branch August 25, 2023 19:22
@bmw
Copy link
Copy Markdown
Member Author

bmw commented Aug 25, 2023

Thanks for the reviews!

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.

3 participants