-
Notifications
You must be signed in to change notification settings - Fork 149
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
Document the things #866
Document the things #866
Conversation
….circle and circleQuad
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.
Looks good. All the rendering issues are probably on my side, but might just want to double check.
Returns | ||
------- | ||
error : ~fipy.variables.cellVariable.CellVariable | ||
The residual vector :math:`\vec{e}=\mathsf{L}\vec{x}_\text{old} - \vec{b}` |
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.
Does not render
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.
FYI, none of this matters if it's just my experience and it's fine on the main website.
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.
Bizarrely inconsistent
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.
@wd15: How do the build products look 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.
I don't see any of the rendered equations in USAGE.html with either Firefox of Chrome. Not to worry if you're seeing them. Something for me to fix.
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.
Nope, they're broken for me in the build artifact, too. I suspect this is because of #776. I'll investigate.
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.
Yep:
2022-05-26T02:15:25.1489657Z WARNING: LaTeX command 'latex' cannot be run (needed for math display), check the imgmath_latex setting
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.
@wd15 Seems fixed now. Can you let me know if you still see any raw LaTeX in the build artifacts?
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.
Local HTML & LaTeX builds look good (no LaTeX artifacts) as of 0539af8.
Returns | ||
------- | ||
error : ~fipy.variables.cellVariable.CellVariable | ||
The residual vector :math:`\vec{e}=\mathsf{L}\vec{x}_\text{old} - \vec{b}` |
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.
I don't see any of the rendered equations in USAGE.html with either Firefox of Chrome. Not to worry if you're seeing them. Something for me to fix.
No description provided.