-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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 two latex issues in docs #13388
Fix two latex issues in docs #13388
Conversation
One or more of the following people are relevant to this code:
|
@@ -33,7 +33,7 @@ class RemoveIdentityEquivalent(TransformationPass): | |||
|
|||
.. math:: | |||
|
|||
\bar{F} = \frac{1 + F_{\text{process}}{1 + d} | |||
\bar{F} = \frac{1 + F_{\text{process}}}{1 + d}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might want to put an enforced space after the comma to improve it - probably one of \
or \quad
depending on how much you want. I'm fine to just merge if this is already good enough for you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this. Any chance you know a simple way to get Sphinx to attempt the renders server side, so we can put the checks in our CI?
For my own website, I run KaTeX deployment-side as part of the page-build operation, but since we're not already running any Node-based stuff here, it'd be a bit of a faff if we had to do that via Node, especially for local contributors.
I don't know of anything off the top of my head, but I added that we should investigate this as part of Qiskit/documentation#2228. I know Kevin Sung had switched Qiskit to Katex with Sphinx, so I'm surprised the Sphinx build pass - I have not yet tried triaging what went wrong. I only just found the issue to begin with. For what it's worth, qiskit/documentation should have caught this issue much sooner. We have a check that every changed page renders, but it didn't correctly run. That's tracked by Qiskit/documentation#2228. So, I didn't notice the issue until doing an open-source sync in the closed source repository. We recently got the nightly dev docs job working, so qiskit/documentation in theory will catch Latex issues every night. That might be sufficient. |
This reverts commit f998723. It's not safe due to Qiskit/qiskit#13388.
Pull Request Test Coverage Report for Build 11635261948Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
KaTeX is also client-side JS-based rendering by default like MathJax, and our Sphinx output is certainly set up for client-side rendering, which is why it's not getting caught here.
Looks like sphinxcontrib-katex
does have a way of doing the pre-rendering if Node is installed, so maybe there's a sensible path through. I wouldn't want to do that as part of the actual build, though, since we don't want to be making the HTML rendering decisions in this repo.
These cause the docs app to crash.