Update the version of Sphinx to 4.0.3#936
Conversation
|
To whomsoever reviews this -- be careful here: Sphinx 4 changed a whole bunch of things around the HTML output and you'd likely want to look at each of the pages where there's directives / tables / images etc and make sure that they look OK. |
|
Thanks for the heads up, @pradyunsg. @meowmeowmeowcat This sounds like a big upgrade, especially given that the primary purpose of this project is to be a documentation site. I'm not a maintainer, but I assume they'll want more information about the benefits of doing this upgrade, and potential breaking changes. It would also be helpful to link to the Sphinx changelog for quick reference. |
|
@bhrutledge upgrading things usually lets us get the latest features and bugfixes, I don't see why we wouldn't want this. Honestly, I'd add a dependabot setup to let it deal with regular autoupdates. I've updated to Sphinx 4 in multiple places and the only issue was with a lexer init in a custom extension that got resolved easily. FWIW I've already green-lighted the upgrade during the review of another PR. P.S. The easiest comparison would probably be generating two docs dirs with different sphinx versions and running |
| @@ -1,4 +1,4 @@ | |||
| sphinx==3.3.0 | |||
| sphinx==4.0.1 | |||
There was a problem hiding this comment.
Let's use the latest bugfix release, no need to hold back:
| sphinx==4.0.1 | |
| sphinx==4.0.3 |
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
|
@meowmeowmeowcat plz post the diff as mentioned above and this should clear the concerns folks have but I personally don't expect you to find anything problematic there. |
|
@bhrutledge The Sphinx changelog for v4.0.3 is here. |
@webknjaz I've tested and the only diff is their version number: |
|
Thanks @webknjaz! |
Things look fine after rebuilding.