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

use sphinx_rtd_theme #2345

Merged
merged 2 commits into from
Sep 6, 2023
Merged

use sphinx_rtd_theme #2345

merged 2 commits into from
Sep 6, 2023

Conversation

jburel
Copy link
Member

@jburel jburel commented Sep 5, 2023

Set rtd theme

@sbesson
Copy link
Member

sbesson commented Sep 5, 2023

This seems to fix the theme regression issue that has been observed between https://omero.readthedocs.io/en/v5.6.8-2/ and https://omero.readthedocs.io/en/v5.6.8-3/.

Is there an official link describing this as a the new canonical way to declare the RTD theme?
Will this be a change to apply across all rtd repositories (i.e. lots of upcoming noise)?

@jburel
Copy link
Member Author

jburel commented Sep 5, 2023

We will have to propagate across all repos.
I have not seen a page
But RTD might have dropped it at some point because it did not have support for Sphinx 7 see readthedocs/sphinx_rtd_theme#1463

The issue is now solved

Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

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

I believe the breaking change was introduced in https://docs.readthedocs.io/en/stable/changelog.html#version-10-2-0 and more specifically readthedocs/readthedocs.org#10638

@jburel
Copy link
Member Author

jburel commented Sep 5, 2023

We are not installing sphinx-rtd-theme automatically on new projects. However, we are setting sphinx_rtd_theme automatically on their docs/conf.py.

This did not happen for us since we are using omero/conf.py (even if it is not a new project) so some of our repos will be okay

@snoopycrimecop
Copy link
Member

Empty PR description. Please add a short summary of the PR scope and some testing instructions.

@jburel jburel merged commit 7ed1159 into ome:develop Sep 6, 2023
@jburel jburel deleted the rtd_theme branch November 23, 2023 11:18
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