armi icon indicating copy to clipboard operation
armi copied to clipboard

Adding tooling to help people build the docs locally

Open john-science opened this issue 7 months ago • 1 comments

What is the change? Why is it being made?

Adding some tooling and automation so that people can more easily build the docs locally.

You will notice in this PR that I had to make changes in the str.rst. Here I reduce the complexity of the doc build by putting code directly into the RST that used to be run on the command line.

SCR Information

Change Type: docs

One-Sentence Description: Adding tooling so that people can more easily build the docs locally.

One-line Impact on Requirements: NA


Checklist

  • [x] This PR has only one purpose or idea.
  • [x] Tests have been added/updated to verify any new/changed code.
  • [x] The documentation is still up-to-date in the doc folder.
  • [x] The code style follows good practices.
  • [x] The dependencies are still up-to-date in pyproject.toml.

john-science avatar Jun 02 '25 20:06 john-science

Okay, here is proof that the HTML and PDFs exist if you run skip_str.py, instead of running the tests. The STR will build, it just won't have test results in it.

https://github.com/terrapower/armi/actions/runs/15427041061?pr=2148

john-science avatar Jun 03 '25 23:06 john-science

@john-science just letting you know that I haven't forgotten about this. just needing to prioritize other end-of-month commitments right now

albeanth avatar Jun 26 '25 18:06 albeanth

Bump

john-science avatar Jul 02 '25 18:07 john-science

Bump

@john-science just letting you know that I haven't forgotten about this. just needing to prioritize other (now behind) end-of-month commitments right now

If you have another review who could take, I will gladly hand it over!

albeanth avatar Jul 03 '25 23:07 albeanth