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

Moving dochelpers out of the ARMI namespace #1662

Merged
merged 5 commits into from
Mar 11, 2024
Merged

Conversation

john-science
Copy link
Member

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:

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

Checklist

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

@john-science john-science added documentation Improvements or additions to documentation cleanup Code/comment cleanup: Low Priority labels Mar 8, 2024
@john-science john-science requested a review from opotowsky March 8, 2024 18:37
@john-science
Copy link
Member Author

john-science commented Mar 8, 2024

This PR is dependent upon this other PR being merged first: #1660

Copy link
Member

@opotowsky opotowsky 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 to me.

@john-science john-science marked this pull request as ready for review March 11, 2024 17:18
@john-science john-science merged commit d788393 into main Mar 11, 2024
21 checks passed
@john-science john-science deleted the ditch_dochelpers branch March 11, 2024 17:28
@tp-pbritt-nuc
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants