Merge pull request #81 from NREL/FixDocs

Fix docs

docs/file_structure.rst

@@ -2,16 +2,18 @@ File & Directory Structure
 ==========================
 
 The program itself is set up to run directly from its repository, and operate
-directly on EnergyPlus build folders.  There is no extra burden required to
-move files around (anymore).  The build folder is expected to have the
+directly on EnergyPlus build or install folders.  There is no extra steps
+required to move files around.  The build folder is expected to have the
 entire set of binaries, including all Fortran tools.  So when configuring the
-build, make sure to set up ``BUILD_FORTRAN``.
+build, make sure to set up ``BUILD_FORTRAN``.  If these tools are not
+built, the regressions will emit a warning that you can accept, but note that
+the program has minimal value if it cannot find and run the Fortran tools.
 
 Test Directory
 --------------
 
-This program runs regression testing for 2 different builds of EnergyPlus
-versions of an executable. The regression tool will verify that the build
+This program runs regression testing for 2 different builds or installs of
+EnergyPlus. The regression tool will verify that the build
 folder looks satisfactory before starting the runs.
 
 When the test is completed, test results will be contained in a Tests

docs/intro.rst

@@ -29,9 +29,11 @@ mathematical comparisons remains.
 Build Structure
 ---------------
 
-This program operates on EnergyPlus build folders.  It relies on the
-build folders having been set up by CMake, as it parses the CMakeCache
-to get access to the base source directory.  With the build and source
+This program operates on EnergyPlus build folders and EnergyPlus install
+folders. It relies on the build folders having been set up by CMake,
+as it parses the CMakeCache to get access to the base source directory.
+For installations, it detects the appropriately installed tools relative
+to the install folder root.  With the build and source
 directories available, the program has everything it needs to run.
 
 Known issues

docs/run_cli.rst

@@ -1,6 +1,8 @@
 Running from Command Line
 =========================
 
+(this page needs a review)
+
 The original design of these scripts was for them to be used from the
 command line. It was only later that the graphical interface was added
 as a front-end for the scripts. Because of this original design, the

docs/run_gui.rst

@@ -54,7 +54,9 @@ Selecting Input Files
 The input files are selected on the second tab. The user can
 select files by double clicking them in the top list, and they can be removed
 by double clicking them in the bottom list.  There are also a few selection options
-for selecting a random set, or selecting/deselecting all.
+for selecting a random set, selecting/deselecting all, and selecting all but the
+known-slowest files.  A recent enhancement now allows the user to select multiple
+files before adding or removing them to the active run list.
 
 Running & Canceling Test Suite
 ------------------------------
@@ -93,8 +95,8 @@ the test suite is complete, messages are sent to this log as well as to
 the GUI itself, so that the GUI can prepare itself for the next run if
 needed.
 
-Last Run Summary & Re-do-ing
-----------------------------
+Last Run Summary
+----------------
 
 When a test suite is completed, the GUI processes the results into a
 useful high-level results structure. This is shown in the following figure:

requirements.txt

@@ -12,6 +12,7 @@ nose==1.3.7
 
 # to generate documentation
 Sphinx==3.2.1
+docutils==0.16   # pinning this because it breaks at 0.18
 
 # for packaging
 pyinstaller