-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Latex equation broken in RZZGate documentation #11358
Comments
This seems to affect other pages as well, such as https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.RXGate Maybe worth searching the repo for all uses of \newcommand ? |
This sounds suspiciously like the KaTeX setup for the markdown components of the new Qiskit/documentation is defining the (Personally I'm not convinced that it's a great idea to use a macro like this in simple definitions, but I know I write LaTeX differently to a lot of people.) |
Oh, come to think of it, I think the Sphinx build used MathJax as its backend when it lived in Terra, but it's now clearly using KaTeX. KaTeX includes a This is one place where the docs-build split is potentially going to cause nuisances, though - the MathJax parsing and rendering engine supports a totally different set of features to KaTeX (imo KaTeX is better). We shouldn't really |
Environment
Online docs
What is happening?
On the RZZGate docs page: https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.RZZGate
An equation that is a helpful reference for getting factors of 2 correct does not render. Mousing over gives the tooltip shown with the error message suggesting to use renewcommand instead of newcommand:

How can we reproduce the issue?
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.RZZGate
What should happen?
Equation should render without an error
Any suggestions?
May just need to replace \newcommand with \renewcommand
The text was updated successfully, but these errors were encountered: