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

Backward compatibility #14

Closed
humitos opened this issue Mar 20, 2023 · 2 comments
Closed

Backward compatibility #14

humitos opened this issue Mar 20, 2023 · 2 comments

Comments

@humitos
Copy link
Member

humitos commented Mar 20, 2023

How much backward compatibility we want to go?

There are bunch of things that are tied to Sphinx in our javascript code (e.g. rst-versions, is_alabaster_like_theme and others). I think that some of these stuffs should be moved to our Sphinx theme itself (e.g. disable default search when if READTHEDOCS) and there are some other stuffs we should stop supporting, I'd say.

@humitos
Copy link
Member Author

humitos commented Mar 24, 2023

From our last meeting, I understand that we want to re-design a lot of stuffs and the HTML structure, CSS classes and others will be different. We even talked about re-designing the flyout completely. We already started re-designing the external version warning in #18.

That said, I think it's fine to remove all the old code that it's there to support edge cases and old Sphinx/MkDocs versions. I'd like to simplify as much as we can the new code removing backward compatibility and starting "fresh", if that's possible. New projects will want to opt-in into the new javascript client because it's gonna be awesome 😄

@humitos
Copy link
Member Author

humitos commented Sep 22, 2023

Lot of things have changed since I opened this issue. The flyout addons looks exactly the same as the old addon and users can opt-in into it now using https://beta.readthedocs.org/ and going to their project's settings.

We have everything from the old integration already implemented in the new addons. I'm closing this issue.

@humitos humitos closed this as completed Sep 22, 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

No branches or pull requests

1 participant