-
Notifications
You must be signed in to change notification settings - Fork 154
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
Tweak documentation #991
Tweak documentation #991
Conversation
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.
LGTM.
Building docs locally has become an exercise for the reader, but this (maybe?) is beyond the scope of this PR.
@@ -41,7 +41,7 @@ | |||
Using this mesh, we can construct a solution variable | |||
|
|||
.. index:: | |||
object: fipy.variables.cellVariable.CellVariable | |||
pair: object; fipy.variables.cellVariable.CellVariable |
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.
What is this supposed to do? When I go to the documentation, I'm not seeing anything to click on or anything at that point in the documentation.
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.
If you look in the index for fipy.variables.cellVariable.CellVariable
, there's a link back to https://pages.nist.gov/fipy/en/tweak_documentation/generated/examples.diffusion.circleQuad.html#index-0.
It's probably stupid. I did it a long time ago and was just bringing the syntax up-to-date.
No description provided.