Moving dochelpers out of the ARMI namespace - Githubissues

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality

https://terrapower.github.io/armi/

Apache License 2.0

214 stars 82 forks source link

Moving dochelpers out of the ARMI namespace #1662

Closed john-science closed 3 months ago

john-science commented 3 months ago

What is the change?

This PR moves dochelpers out of the ARMI namespace.

In particular, it splits the file armi/utils/dochelpers.py into two parts and puts them in:

doc/conf.py - The classes ExecDirective and PyReverse were only ever used in our conf.py anyway.
doc/.static/dochelpers.py - There were some really simple helper functions here imported by the docs.

Why is the change being made?

The purpose of this PR is two-fold:

This code should never have been part of the ARMI namespace; it has nothing to do with nuclear modeling.
To remove docutils as a primary dependency of ARMI.

Checklist

[X] This PR has only one purpose or idea.
[X] Tests have been added/updated to verify any new/changed code.

[X] The code style follows good practices.
[X] The commit message(s) follow good practices.

[X] The release notes have been updated if necessary.
[X] The documentation is still up-to-date in the doc folder.
[X] The dependencies are still up-to-date in pyproject.toml.

john-science commented 3 months ago

This PR is dependent upon this other PR being merged first: https://github.com/terrapower/armi/pull/1660

tp-pbritt-nuc commented 3 months ago

@john-science This change broke Pylot docs. Could you take a look when you have a chance?