very minor cleanup

.github/workflows/docs.yaml

@@ -52,7 +52,7 @@ jobs:
           echo "make latex:"
           make latex
           cd _build/latex/
-          echo "latexmk -pdf -f ARMI.tex:"
+          echo "latexmk -pdf -f -interaction=nonstopmode ARMI.tex:"
           latexmk -pdf -f -interaction=nonstopmode ARMI.tex
       - name: Deploy
         if: github.ref == 'refs/heads/main'

doc/conf.py

@@ -126,9 +126,9 @@ class PyReverse(Directive):
     The directive accepts the same arguments as pyreverse, except you should not specify
     ``--project`` or ``-o`` (output format). These are automatically specified.
 
-    If you pass ``-c`` to this, the figure generated is forced to be the className.png like
-    ``BurnMatrix.png``. For .gitignore purposes, this is a pain. Thus, we auto-prefix ALL images
-    generated by this directive with ``pyrev_``.
+    If you pass ``-c`` to this, the figure generated is forced to be the className.png like. For
+    .gitignore purposes, this is a pain. Thus, we auto-prefix ALL images generated by this directive
+    with ``pyrev_``.
     """
 
     has_content = True
@@ -320,12 +320,12 @@ def setup(app):
 root_doc = "index"
 
 # General information about the project.
-project = "ARMI"
 copyright = "2009-{}, TerraPower, LLC".format(datetime.datetime.now().year)
+project = "ARMI"
 
 # Use the pre-existing version definition.
-version = meta.__version__
 release = meta.__version__
+version = meta.__version__
 
 # List of patterns, relative to source directory, that match files and directories to ignore when
 # looking for source files.
@@ -389,7 +389,7 @@ def setup(app):
 html_style = "css/theme_fixes.css"
 
 # The name of an image file (within the static path) to use as favicon of the docs. This file should
-# be a Windows icon file (.ico) being 16x16 or 32x32 pixels large.
+# be a icon file (.ico) being 16x16 or 32x32 pixels large.
 html_favicon = os.path.join(STATIC_DIR, "armiicon_16x16.ico")
 
 # Add any paths that contain custom static files (such as style sheets) here, relative to this
@@ -440,12 +440,10 @@ def setup(app):
     )
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
+# The name of an image file (relative to this directory) to place at the top ofthe title page.
 latex_logo = os.path.join(STATIC_DIR, "armi-logo.png")
 
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
+# For "manual" documents, if this is true, then toplevel headings are parts, not chapters.
 latex_toplevel_sectioning = "part"
 
 # If true, show page references after internal links.
@@ -482,21 +480,20 @@ def setup(app):
 
 suppress_warnings = ["autoapi.python_import_resolution"]
 
-# filter out this warning which shows up in sphinx-gallery builds.
-# this is suggested in the sphinx-gallery example but doesn't actually work?
+# filter out this warning which shows up in sphinx-gallery builds. This is suggested in the
+# sphinx-gallery example but doesn't actually work?
 warnings.filterwarnings(
     "ignore",
     category=UserWarning,
-    message="Matplotlib is currently using agg, which is a non-GUI"
-    " backend, so cannot show the figure.",
+    message="Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the "
+    "figure.",
 )
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
-# these are defaults in Windows in more recent versions of the imgconverter plugin and
-# can be removed if/when we upgrade Sphinx beyond 2.2.
-# Otherwise, 'convert' from system32 folder is used.
-if "win32" in sys.platform:
+# These are defaults in Windows in more recent versions of the imgconverter plugin and can be
+# removed if/when we upgrade Sphinx beyond 2.2. Otherwise, 'convert' from system32 folder is used.
+if sys.platform.startswith("win"):
     image_converter = "magick"
     image_converter_args = ["convert"]
 

doc/glossary.rst

@@ -13,16 +13,15 @@ Here we define a few specialized terms used in this documentation.
         for nuclear reactor design and analysis.
 
     assembly
-        a basic structural unit in the reactor core that is stacked together by
-        a list of blocks. Assemblies typically move together in fuel management.
+        A basic structural unit in the reactor core that is stacked together by a list of blocks.
+        Assemblies typically move together in fuel management.
 
     block
         a vertical segment of the assembly consisting of components.
 
     burnup
-        Amount of energy that has been extracted from fuel. Can be measured
-        in megawatt-days per kilogram of heavy metal (MWd/kgHM) or
-        in percent of fissionable atoms that have fissioned.
+        Amount of energy that has been extracted from fuel. Can be measured in megawatt-days per
+        kilogram of heavy metal (MWd/kgHM) or in percent of fissionable atoms that have fissioned.
 
     BOC
         Beginning-of-cycle; the state of the core after an outage
@@ -37,12 +36,12 @@ Here we define a few specialized terms used in this documentation.
         Command Line Interface. The method of interacting with software from a command line.
 
     component
-        the basic primitive geometrical body, such as a circle, hex, helix, etc. These have dimensions, 
-        temperatures, material properties, and isotopic composition.
+        the basic primitive geometrical body, such as a circle, hex, helix, etc. These have
+        dimensions, temperatures, material properties, and isotopic composition.
 
     FIMA  
-        Fissions per initial metal atom. This is a unit of measuring burnup as a fraction
-        of the fissionable nuclides that have fissioned.
+        Fissions per initial metal atom. This is a unit of measuring burnup as a fraction of the
+        fissionable nuclides that have fissioned.
 
     grid plate
         A reactor structure in a sodium-cooled fast reactor that all the fuel assemblies sit on.
@@ -51,18 +50,18 @@ Here we define a few specialized terms used in this documentation.
         Graphical User Interface. The method of interacting with software through a visual display.
 
     interface
-        also named *code interface*; linked to an external program or an
-        internal ARMI module to perform a specific calculation function. An example
-        is the DIF3D interface that makes use of DIF3D diffusion code for core physics
-        calculation. Interfaces are building blocks of ARMI calculations
+        Also named *code interface*; linked to an external program or an internal ARMI module to
+        perform a specific calculation function. An example is the DIF3D interface that makes use of
+        DIF3D diffusion code for core physics calculation. Interfaces are building blocks of ARMI
+        calculations
 
     In-Use Tests
-        Automated software test that shows many modules working together in a way that
-        a user would typically use them.
+        Automated software test that shows many modules working together in a way that a user would
+        typically use them.
 
     Liner
-        A thin layer of material between fuel and cladding intended to impede chemical
-        corrosion and wastage.
+        A thin layer of material between fuel and cladding intended to impede chemical corrosion and
+        wastage.
 
     LWR
         Light Water Reactor. The predominant kind of commercial nuclear plant in operation today.
@@ -71,21 +70,22 @@ Here we define a few specialized terms used in this documentation.
         an object that contains isotopic mass fractions and intrinsic material properties
 
     MPI
-        Message passing interface. This is a protocol for exchanging data around a network to run a code in parallel.
+        Message passing interface. This is a protocol for exchanging data around a network to run a
+        code in parallel.
 
     node
-        a specific point in time in a ARMI case.
+        A specific point in time in a ARMI case.
 
     operator
-        an object that controls the calculation sequence for a specific purpose e.g. a multi-cycle
+        An object that controls the calculation sequence for a specific purpose e.g. a multi-cycle
         quasi-static depletion calculation. Operators trigger interfaces.
 
     parameter
         A state variable on a reactor, assembly, block, or component object.
 
     plenum
-        An empty space inside the cladding tube above the fuel that holds fission gasses and other things that are produced
-        during irradiation.
+        An empty space inside the cladding tube above the fuel that holds fission gasses and other
+        things that are produced during irradiation.
 
     reactor
         an object consisting of a core full of assemblies and possibly other structures
@@ -96,21 +96,21 @@ Here we define a few specialized terms used in this documentation.
         strain, arrangement, orientation, and so on.
 
     smear density
-        A term used to characterize how much room exists inside the cladding for the fuel to expand into. It is defined
-        as the fraction of fuel area divided by total space inside the cladding.
+        A term used to characterize how much room exists inside the cladding for the fuel to expand
+        into. It is defined as the fraction of fuel area divided by total space inside the cladding.
 
     TWR
-        Traveling wave reactor: a reactor that uses a breed-and-burn process to achieve most fast reactor advantages
-        without requiring a reprocessing plant.
+        Traveling wave reactor: a reactor that uses a breed-and-burn process to achieve most fast
+        reactor advantages without requiring a reprocessing plant.
 
     Unit Tests
         Software tests that check small units of software.
 
     V&V
-        Validation and Verification. Validation is showing that code results match physical reality (comparisons with known answers or experiments),
-        and verification is demonstrating that software is built in a way that satisfies its requirements.
+        Validation and Verification. Validation is showing that code results match physical reality
+        (comparisons with known answers or experiments), and verification is demonstrating that
+        software is built in a way that satisfies its requirements.
 
     XTVIEW
-        A TerraPower-developed visualization tool that graphically shows ARMI results that
-        have been added to a database.
-
+        A TerraPower-developed visualization tool that graphically shows ARMI results that have been
+        added to a database.

doc/make.bat

@@ -3,8 +3,7 @@
 pushd %~dp0
 
 REM Command file for Sphinx documentation for ARMI
-REM This can be run locally with make html
-REM or remotely on a HPC cluster.
+REM This can be run locally with make html.
 
 if "%PYTHON%" == "" (
 	set PYTHON=python