-
Notifications
You must be signed in to change notification settings - Fork 53
Fix docs/components #1288
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
base: main
Are you sure you want to change the base?
Fix docs/components #1288
Conversation
Signed-off-by: furqan463 <ahmadfurqanc@gmail.com>
|
I could fix equation rendering in |
|
There are errors in other files too like LU solver and in calculations. Initial idea about the ticket was to find out a way which does not require modifying each equation with such issue. Maybe there is a way we can resolve this at sphinx or myst or mathjax side directly. |
I had the same intention but couldn't find a way. |
docs/user_manual/components.md
Outdated
| $$ | ||
| \begin{eqnarray} | ||
| & P_{\text{gen}} = P_{\text{specified}} \\ | ||
| & Q_{\text{gen}} = Q_{\text{min}} \text{ or } Q_{\text{max}} \\ | ||
| & P_{\text{gen}} = P_{\text{specified}} | ||
| \end{eqnarray} | ||
| $$ | ||
| $$ | ||
| \begin{eqnarray} | ||
| & Q_{\text{gen}} = Q_{\text{min}} \text{ or } Q_{\text{max}} | ||
| \end{eqnarray} | ||
| $$ | ||
| $$ | ||
| \begin{eqnarray} | ||
| & |U_{\text{node}}| = \text{calculated from power flow} | ||
| \end{eqnarray} | ||
| $$ |
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.
Can you try this instead?
$$\begin{eqnarray}
& P_{\text{gen}} = P_{\text{specified}} \\
& Q_{\text{gen}} = Q_{\text{min}} \text{ or } Q_{\text{max}} \\
& |U_{\text{node}}| = \text{calculated from power flow}
\end{eqnarray}$$
See https://stackoverflow.com/questions/18860693/mathjax-multi-line-equation-rendering-issue
(Edit: It also suggests changing to align instead of eqnarray though)
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.
Can you try this instead?
$$\begin{eqnarray} & P_{\text{gen}} = P_{\text{specified}} \\ & Q_{\text{gen}} = Q_{\text{min}} \text{ or } Q_{\text{max}} \\ & |U_{\text{node}}| = \text{calculated from power flow} \end{eqnarray}$$See https://stackoverflow.com/questions/18860693/mathjax-multi-line-equation-rendering-issue
(Edit: It also suggests changing to align instead of eqnarray though)
This makes no difference. align* works after building the document, however live preview while editing is not available.
Fixes issue: #1278
Changes proposed in this PR include:
multi-line equations inside
$$delimiter do not render properly. I've replaced them with multiple$$math blocks.Checks