Missing picture in the nuclideBases description

[keckler]

If you're looking at the Sphinx documentation for the nuclideBases module, you might notice that there is a link to a figure in the docstring:

This link goes nowhere for me, I think because the figure doesn't exist.

[john-science]

I can confirm this has been broken since the 0.2.0 release on Nov 19, 2021: https://terrapower.github.io/releases/armi/v0.2.0/.apidocs/armi.nucDirectory.nuclideBases.html

@ntouran How long has it been since these class diagrams displayed?

[john-science]

Okay, it is my guess here that our docs used to have some automagical class diagrams, but only a couple relics of this remain.

Probably, these diagrams were just fragile and hard to maintain. (Such things always are.)

I am thinking that removing these defunct links and this dependency is the right solution:

armi/doc/conf.py

Line 115 in 2ae923e

"sphinx.ext.inheritance_diagram",

[john-science]

Okay, I take it all back. This appears to be because the pylint library was left out of the doc/requirements-docs.txt.

We use pyreverse to make our UML diagrams. But the pyreverse project was moved into pylint, to pylint.pyreverse.

I will add that in. Easy fix.

[john-science]

Okay, @keckler , there is a PR open for this: #556

[keckler]

I just looked at this issue specifically in the docs, and I don't think it was actually resolved.

Am I crazy?

[john-science]

Damn, @keckler , you're right.

The PR worked on my computer, so that means something is not set up on our GitHub Actions. And I just found it. Graphviz needs to be installed to make those plots.

Of course I have it installed on my personal machine, and my work machine, and it's outside the Python env, so it was an invisible dependency for the PR. I will push that change now.

Good find, man.

[keckler]

Looks good!