-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Prepare for 3.0 release #1576
Prepare for 3.0 release #1576
Conversation
It seems we had a bug in the name and it wasn't installing Sphinx from `master`. I expect this test to fail now because we pin `Sphinx<8`, but that's fine for now.
- Drop Python <3.8 - Drop docutils <=0.18 - Add support for docutils 0.21 - Add support for Python 3.12 This follows the plan we wrote in https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap-release-3-0-0 The main idea here is to move forward with newer versions and drop support for old stuffs so we reduce the maintanence burden.
Sphinx 8 was just released, it probably makes sense to try to include support for that here (assuming it's not an unreasonable amount of work). |
…theme into humitos/plan-3.0
And 2.0.0 version has a problem w/ it: #1571 |
We should include a deprecation warning in 3.0, so we can remove it in 4.0 (from #450 (comment)). I agree with that 👍🏼 |
…theme into humitos/plan-3.0
I did some QA here using
I haven't find any difference here, so I think we are good to go 👍🏼 After that, I switch to this PR in particular and run |
I added a few extra commits to update the docs and add some deprecation warnings 👍🏼 |
Closes #1533
Also, you don't mention this above, but if you aren't already you should also test multiple browsers and also test for tablet/mobile viewport. Chromium is fairly compatible with Firefox these days, Webkit usually gives the most unexpected results. Mobile and tablet viewport sizes mostly affect elements that require positioning, like footnotes, sidebar, and tables. |
I did this and there are some differences. Depending on the "Dimensions" and "Rotation" it renders better in the old or new versions --but also it seems they are fixed in Sphinx 8.x (or even in the development branch) because I'm not able to reproduce them there. I think we can make a more extensive QA here as we go and open specific issues. I haven't found anything completely broken, tho, so I don't want to block moving forward with a release that supports Sphinx 8.x because of this. I will merge this PR and release a 3.0.0rc1 so users can start using/testing it and report specific issues we can work on. Currently, Sphinx 8.x users are getting 0.5.x version of the theme which is worse than that the current one -- even with this small issues on tablet/mobile issues. |
Great to hear @humitos , thanks! |
This was already added in a more generic way to the theme itself.
@humitos Could you note the differences in an issue? We should follow up on these after an RC is out. Styling does not frequently break completely, normally differences in docutils releases (and sometimes Sphinx) causes either changes in spacing, sizing, or positioning. Sometimes entire structures have changed (footnotes) and rendering is completely different. |
This PR prepares the theme for the 3.0 release as planned in https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap-release-3-0-0
Related PRs I'd like to include here as well:
READTHEDOCS_PROJECT
from environment variables #1578flyout
to enable/disable theme's flyout #1580html_context
withREADTHEDOCS_*
environment variables #1581Closes #1570
Closes #1582
Closes #1559
Closes #1557