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.

Sign up for GitHub

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

Jump to bottom

Proposal: Stop using sphinx-rtd-theme #53

Open
auscompgeek opened this issue Feb 2, 2023 · 3 comments
Open

Proposal: Stop using sphinx-rtd-theme #53

auscompgeek opened this issue Feb 2, 2023 · 3 comments

Comments

@auscompgeek
Copy link
Member

auscompgeek commented Feb 2, 2023 •
edited
Loading

The latest version of sphinx-rtd-theme (1.1.1) is incompatible with Sphinx 6: the navigation sidebar depends on jQuery. https://blog.readthedocs.com/sphinx6-upgrade/

Maintenance on sphinx-rtd-theme appears to be quite slow: there was over a year gap between 1.0 and 1.1.

The wider Python community seem to have moved to other Sphinx themes. In particular, furo, by one of the PyPA folks, appears to have become quite popular, has dark theme support, and uses very little JavaScript.
@virtuald
Copy link
Member

virtuald commented Feb 3, 2023

Meh.

@TheTripleV
Copy link
Member

TheTripleV commented Feb 3, 2023 •
edited
Loading

I don't think this matters as much as I expect most docs to be migrated over next year anyway.

@auscompgeek
Copy link
Member Author

We'd still have API docs though?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@auscompgeek @virtuald @TheTripleV