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 search through bumping the underlying RTD theme that fixed the issue #14

Closed
wants to merge 1 commit into from

Conversation

imrehg
Copy link
Member

@imrehg imrehg commented Dec 16, 2021

The search issue was due to Sphinx changes and fixed in readthedocs/sphinx_rtd_theme#1021
that was released in the 0.5.1 version of the theme, so that's the earliest we can bump to to have functioning search again.

Looking at versions since then, the latest (1.0.0) version seems to have identical results in the compiled documentation, so
bumping to that version is likely more future proof.

The search issue was due to Sphinx changes and fixed in readthedocs/sphinx_rtd_theme#1021
that was released in the 0.5.1 version of the theme, so that's the earliest we
can bump to to have functioning search again.

Looking at versions since then, the latest (1.0.0) version seems
to have identical results in the compiled documentation, so
bumping to that version is likely more future proof.
@acroz
Copy link
Member

acroz commented Dec 16, 2021

I pinned this dependency as some of the styling changes in the RTD theme broke the CSS hacks in this repo. Have you run this with a more complex docs site e.g. the Faculty platform docs? I think if you do you may find that some of our style overrides are broken.

@imrehg
Copy link
Member Author

imrehg commented Dec 16, 2021

@acroz I've tried the current docs (normal working pages) and the updated version side by side before doing this PR but after retesting it, I do see the sort of breakages you mean (especially in the documentation sections it's quite clear, headers spanning full length of page rather than being boxes)

Sorry about that being sloppy.

I have some ideas for doing a more proper search fix, let's close this one for now until that one is clearer.

@imrehg imrehg closed this Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants