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

Fix error when building with Sphinx 4.5 #16193

Merged
merged 1 commit into from Jul 5, 2022
Merged

Conversation

mitya57
Copy link
Contributor

@mitya57 mitya57 commented Jun 15, 2022

Ideally, we should stop monkey-patching and forward the fix to Sphinx upstream. I don't know details of the fix, so it would be better if the original author @cpitclaudel does this.

Fixes / closes #15956

@rwmjones
Copy link

I tested this patch and it fixes the problem we had building Coq in Fedora Rawhide with the latest Sphinx.

@Alizter
Copy link
Contributor

Alizter commented Jun 19, 2022

@Zimmi48 what more needs to be done for this?

@rwmjones
Copy link

@Zimmi48
Copy link
Member

Zimmi48 commented Jun 20, 2022

As the author of the PR wrote, this patch cannot be merged as is because it breaks the build with older Sphinx version. Probably it should be a draft PR to reflect this.

We are also looking for feedback from @cpitclaudel on this code to know how to proceed.

@Zimmi48 Zimmi48 marked this pull request as draft June 20, 2022 08:15
@SkySkimmer
Copy link
Contributor

Can we do something like if sphinx_version < whatever then previous code else new code? (the CR is just \n so we don't need to import it)

@mitya57
Copy link
Contributor Author

mitya57 commented Jun 23, 2022

Can we do something like if sphinx_version < whatever then previous code else new code? (the CR is just \n so we don't need to import it)

Done. I left CR imported to make it easier to compare patched function with original version.

@mitya57 mitya57 marked this pull request as ready for review June 23, 2022 17:50
@cpitclaudel
Copy link
Contributor

I will try to look this weekend

@Zimmi48 Zimmi48 added kind: documentation Additions or improvement to documentation. kind: compatibility Changes allowing for compatibility between versions. labels Jul 4, 2022
@Zimmi48 Zimmi48 modified the milestone: 8.16.0 Jul 4, 2022
Copy link
Member

@Zimmi48 Zimmi48 left a comment

Choose a reason for hiding this comment

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

FWIW, I am fine with merging this solution.

@cpitclaudel Did you get the chance to look at it?

@cpitclaudel
Copy link
Contributor

Oh, the patch looks fine (thanks @mitya57!). By look at I meant that I'd try to upstream the change, but since I haven't had time since two weeks ago it's unlikely that I'll find the time soon :/ @mitya57 would you fell comfortable opening a PR on the Sphinx side?

@Zimmi48 Zimmi48 self-assigned this Jul 5, 2022
@Zimmi48
Copy link
Member

Zimmi48 commented Jul 5, 2022

@coqbot merge now

@mitya57
Copy link
Contributor Author

mitya57 commented Jul 7, 2022

By look at I meant that I'd try to upstream the change, but since I haven't had time since two weeks ago it's unlikely that I'll find the time soon :/ @mitya57 would you fell comfortable opening a PR on the Sphinx side?

Done in sphinx-doc/sphinx#10647.

@cpitclaudel
Copy link
Contributor

Thanks!

ppedrot added a commit to ppedrot/coq that referenced this pull request Jul 21, 2022
@coqbot-app coqbot-app bot moved this from Request 8.16.0 inclusion to Shipped in 8.16.0 in Coq 8.16 Jul 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: compatibility Changes allowing for compatibility between versions. kind: documentation Additions or improvement to documentation.
Projects
No open projects
Coq 8.16
  
Shipped in 8.16.0
Development

Successfully merging this pull request may close these issues.

LaTeX documentation doesn't build with Sphinx 4.5.0
6 participants