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

Looks like this one is no longer working with the latest ReadTheDocs hosting service #2

Closed
MacHu-GWU opened this issue Dec 12, 2024 · 5 comments

Comments

@MacHu-GWU
Copy link

MacHu-GWU commented Dec 12, 2024

Hi @harshil21 Looks like the readthedocs-sphinx-search package got some updates. I don't know what is actually changed on their side.

I am not a javascript guy, but I guess it might be the rtd recently changed some of their API endpoint.

@harshil21
Copy link
Owner

hey.

Readthedocs recently launched their own integrated search functionality for all sites in a server side update, which is basically based on readthedocs-sphinx-search.

I need to check if this extension can still be used to theme that.

@MacHu-GWU
Copy link
Author

@harshil21 Take your time man. I really love your plugin.

@MacHu-GWU
Copy link
Author

@harshil21 I read all your js code, but I didn't see what's the core change you made to support search as you type in furo theme, may I know how does it works actually?

@harshil21
Copy link
Owner

I read all your js code, but I didn't see what's the core change you made to support search as you type in furo theme, may I know how does it works actually?

The changes to the actual colors are done in the css file. I only realize now that I didn't explicitly document which values I changed...

Anyway I looked further into this. readthedocs#144 mentions that it is being deprecated and archived. This basically means that this fork is also dead since the changes for the search as you type addon is now all done server side (https://docs.readthedocs.io/en/stable/server-side-search/index.html). The regular dark mode version of that looks quite good and they have improved the design quite a bit.

As for making it "furo" themed, this is technically going to be handled by furo themselves - see pradyunsg/furo#795. I don't think it's worth for me to keep maintaining this extension anymore. I will be archiving this repository soon.

@harshil21 harshil21 pinned this issue Dec 20, 2024
@MacHu-GWU
Copy link
Author

Got it, thanks for providing the context. This definitely a mission impossible, thank you.

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

No branches or pull requests

2 participants