Merge pull request #1146 from NREL/arg-summary

RTD: summarize lookup arguments
NREL · Nov 27, 2023 · 6f477c0 · 6f477c0
2 parents d07e786 + 1a41b31
commit 6f477c0
Show file tree

Hide file tree

Showing 36 changed files with 16,757 additions and 1,586 deletions.
diff --git a/.github/workflows/config.yml b/.github/workflows/config.yml
@@ -351,6 +351,7 @@ jobs:
 
       - name: Build documentation
         run: |
+          sudo gem install oga
           ruby docs/read_the_docs/source/workflow_inputs/create_characteristics_rst.rb
           ruby docs/read_the_docs/source/workflow_outputs/csv_tables.rb
           cd docs/read_the_docs

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ Features
 - Add ability to calculate detailed utility bills based on a user-specified TSV file of paths to JSON utility rate tariff files ([#1109](https://github.com/NREL/resstock/pull/1109))
 - Update to OpenStudio v3.7.0 ([#1144](https://github.com/NREL/resstock/pull/1144))
 - Update to RECS 2020 V5 data files ([#1164](https://github.com/NREL/resstock/pull/1164))
+- Automate creation of new "Arguments" documentation sections for summarizing arguments (and their default values) in options_lookup.tsv ([#1146](https://github.com/NREL/resstock/pull/1146))
 
 Fixes
 - Set standard format for options_lookup ([#962](https://github.com/NREL/resstock/pull/962))

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -5,38 +5,35 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     docile (1.4.0)
-    minitest (5.14.4)
-    minitest-reporters (1.4.3)
+    minitest (5.20.0)
+    minitest-reporters (1.6.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    msgpack (1.5.1)
-    nokogiri (1.12.5-x64-mingw32)
+    msgpack (1.7.2)
+    nokogiri (1.15.4-x64-mingw32)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
-      racc (~> 1.4)
-    oga (3.3)
+    oga (3.4)
       ast
       ruby-ll (~> 2.1)
-    parallel (1.21.0)
-    racc (1.6.0)
+    parallel (1.23.0)
+    racc (1.7.1)
     rake (13.0.6)
-    ruby-ll (2.1.2)
+    ruby-ll (2.1.3)
       ansi
       ast
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   x64-mingw32
-  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.9)
@@ -51,4 +48,4 @@ DEPENDENCIES
   simplecov-html
 
 BUNDLED WITH
-   2.2.29
+   2.1.4
diff --git a/docs/read_the_docs/source/advanced_tutorial/index.rst b/docs/read_the_docs/source/advanced_tutorial/index.rst
@@ -17,4 +17,4 @@ If your changes are intended to be merged into the ``develop`` branch of the `Re
    options_lookup
    increasing_upgrade_options
    upgrade_scenario_config
-   heat_pump_upgrades
+   heat_pump_upgrades
diff --git a/docs/read_the_docs/source/basic_tutorial/architecture.rst b/docs/read_the_docs/source/basic_tutorial/architecture.rst
@@ -68,6 +68,8 @@ The BuildExistingModel and ApplyUpgrade meta measures call the following model m
   3     BuildResidentialScheduleFile  Model              No                      OS-HPXML
   ===== ============================= ================== ========= ============= ==========================
 
+.. _model-measures:
+
 Model Measures
 **************