Skip to content

Update the version of Sphinx to 4.0.3#936

Merged
webknjaz merged 2 commits intopypa:mainfrom
dukecat0:Update-Sphinx-version
Jul 8, 2021
Merged

Update the version of Sphinx to 4.0.3#936
webknjaz merged 2 commits intopypa:mainfrom
dukecat0:Update-Sphinx-version

Conversation

@dukecat0
Copy link
Copy Markdown
Member

@dukecat0 dukecat0 commented Jul 8, 2021

Things look fine after rebuilding.

@pradyunsg
Copy link
Copy Markdown
Member

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.

@bhrutledge
Copy link
Copy Markdown
Contributor

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.

@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented Jul 8, 2021

@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 diff -ur dir1 dir2 against that.

Comment thread requirements.txt Outdated
@@ -1,4 +1,4 @@
sphinx==3.3.0
sphinx==4.0.1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the latest bugfix release, no need to hold back:

Suggested change
sphinx==4.0.1
sphinx==4.0.3

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
@webknjaz webknjaz changed the title Update the version of Sphinx to 4.0.1 Update the version of Sphinx to 4.0.3 Jul 8, 2021
@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented Jul 8, 2021

@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.

@dukecat0
Copy link
Copy Markdown
Member Author

dukecat0 commented Jul 8, 2021

@bhrutledge The Sphinx changelog for v4.0.3 is here.

@dukecat0
Copy link
Copy Markdown
Member Author

dukecat0 commented Jul 8, 2021

@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.

@webknjaz I've tested and the only diff is their version number:

-    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.3.0.
+    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.3.

@webknjaz webknjaz enabled auto-merge July 8, 2021 14:06
@webknjaz webknjaz merged commit 60b75be into pypa:main Jul 8, 2021
@dukecat0
Copy link
Copy Markdown
Member Author

dukecat0 commented Jul 8, 2021

Thanks @webknjaz!

@dukecat0 dukecat0 deleted the Update-Sphinx-version branch July 8, 2021 14:10
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

Successfully merging this pull request may close these issues.

4 participants