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

Document the things #866

Merged
merged 13 commits into from Jun 1, 2022
Merged

Document the things #866

merged 13 commits into from Jun 1, 2022

Conversation

guyer
Copy link
Member

@guyer guyer commented May 20, 2022

No description provided.

@guyer guyer requested review from tkphd and wd15 May 20, 2022 16:51
Copy link
Contributor

@wd15 wd15 left a 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.

documentation/USAGE.rst Show resolved Hide resolved
documentation/USAGE.rst Show resolved Hide resolved
documentation/USAGE.rst Show resolved Hide resolved
documentation/USAGE.rst Show resolved Hide resolved
documentation/USAGE.rst Show resolved Hide resolved
fipy/terms/term.py Show resolved Hide resolved
fipy/terms/term.py Show resolved Hide resolved
Returns
-------
error : ~fipy.variables.cellVariable.CellVariable
The residual vector :math:`\vec{e}=\mathsf{L}\vec{x}_\text{old} - \vec{b}`
Copy link
Contributor

Choose a reason for hiding this comment

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

Does not render

Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Bizarrely inconsistent

Copy link
Member Author

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?

Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Member Author

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

Copy link
Member Author

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?

Copy link
Contributor

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.

fipy/variables/variable.py Show resolved Hide resolved
fipy/variables/variable.py Show resolved Hide resolved
@guyer guyer requested a review from wd15 May 26, 2022 14:00
documentation/USAGE.rst Show resolved Hide resolved
Returns
-------
error : ~fipy.variables.cellVariable.CellVariable
The residual vector :math:`\vec{e}=\mathsf{L}\vec{x}_\text{old} - \vec{b}`
Copy link
Contributor

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.

@guyer guyer requested a review from wd15 May 27, 2022 16:22
@guyer guyer merged commit 17380a9 into usnistgov:master Jun 1, 2022
@guyer guyer deleted the document_the_things branch June 1, 2022 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants