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

Update to sphinx 7 #2360

Merged
merged 3 commits into from
Nov 11, 2023
Merged

Update to sphinx 7 #2360

merged 3 commits into from
Nov 11, 2023

Conversation

GrahamSH-LLK
Copy link
Contributor

@GrahamSH-LLK GrahamSH-LLK commented Oct 23, 2023

Currently first pass

@GrahamSH-LLK GrahamSH-LLK changed the title First pass at updating to modern sphinx Update to modern sphinx Oct 23, 2023
@sciencewhiz sciencewhiz requested a review from Daltz333 October 23, 2023 02:52
@sciencewhiz
Copy link
Collaborator

sciencewhiz commented Oct 23, 2023

Unfortunately, It's fairly common for things to break on big upgrades like this in the past.

Here's what I've noticed:

  • colors on the front page panels shifted slightly (not necessarily a problem, but a possible indication of other CSS issues)
  • 404 page is all messed up
  • sphinx-rtd-theme v2 (which looks to add support for Sphinx 7) should be released soon. Not sure what might be broken with the older version. Looks like 1.3 is ok for Sphinx 7

I'm not sure if there's a way to see if translations or pdf/html still works without merging @Daltz333

@Daltz333
Copy link
Member

You can build translations locally to test, but I'd just rely on CI to test PDF builds.

@sciencewhiz
Copy link
Collaborator

sciencewhiz commented Oct 23, 2023

Looks like translations failed
CI PDF looks reasonable
build times look to be about the same

@GrahamSH-LLK
Copy link
Contributor Author

GrahamSH-LLK commented Oct 23, 2023

wpilibsuite/frc-docs-translations#36 should fix the translations
404 also works now

@sciencewhiz
Copy link
Collaborator

The colors on the front panels seem back to normal

@Daltz333
Copy link
Member

Daltz333 commented Nov 3, 2023

Needs a rebase

@GrahamSH-LLK
Copy link
Contributor Author

Needs a rebase

Rebased and builds succeeding.

@sciencewhiz sciencewhiz changed the title Update to modern sphinx Update to sphinx 7 Nov 11, 2023
@sciencewhiz sciencewhiz merged commit 7004782 into wpilibsuite:main Nov 11, 2023
sciencewhiz added a commit to sciencewhiz/frc-docs that referenced this pull request Nov 11, 2023
sciencewhiz added a commit that referenced this pull request Nov 11, 2023
@GrahamSH-LLK
Copy link
Contributor Author

@sciencewhiz Strange that it failed. I can repro the problem locally by running the command that rtd runs for whatever part of the build it is that failed. However, I can't figure out where the problem is as the stack trace is fairly unhelpful.

@sciencewhiz
Copy link
Collaborator

@TheTripleV
Copy link
Member

Adding *args, **kwargs to both inits (definition and call) should make it work on current sphinx and sphinx 7.

@GrahamSH-LLK
Copy link
Contributor Author

Fixed PR in #2395

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