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

Fix Read the Docs build #1668

Merged
merged 2 commits into from
Sep 6, 2023
Merged

Fix Read the Docs build #1668

merged 2 commits into from
Sep 6, 2023

Conversation

pquentin
Copy link
Member

@pquentin pquentin commented Sep 6, 2023

The .readthedocs.yaml file is now required: https://blog.readthedocs.com/migrate-configuration-v2/

I faced two main issues here:

  • Our config file was not asking for sphinx-rtd-theme on Read the Docs, which was useful long ago but prevented the theme to be used today. This is why https://elasticsearch-dsl.readthedocs.io/en/latest/ shows the default theme instead (alabaster).
  • By default, Read the Docs installs old versions of sphinx and sphinx-rtd-theme, so I had to put lower bounds to avoid that.

@pquentin pquentin closed this Sep 6, 2023
@pquentin pquentin reopened this Sep 6, 2023
@JoshMock
Copy link
Member

JoshMock commented Sep 6, 2023

Looks like a couple small CI failures, but everything looks good on the whole. 👍

@pquentin
Copy link
Member Author

pquentin commented Sep 6, 2023

I have enabled the Read the Docs pull request integration so the result can be seen here: https://elasticsearch-dsl--1668.org.readthedocs.build/en/1668/. Please take another look as I have continued to tweak things to make the build work.

@pquentin pquentin merged commit 29ca74d into elastic:main Sep 6, 2023
13 checks passed
@pquentin pquentin deleted the rtd branch September 6, 2023 19:06
pquentin added a commit that referenced this pull request Sep 7, 2023
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