RTD: detailed changelog

.github/pull_request_template.md

@@ -9,6 +9,6 @@ Not all may apply:
 - [ ] Tests (and test files) have been updated
 - [ ] Documentation has been updated
   - [ ] If related to resstock-estimation, checklist includes [data dictionary](https://github.com/NREL/resstock/tree/develop/resources/data/dictionary), [source report](https://github.com/NREL/resstock/tree/develop/project_national/resources/source_report.csv), [options saturation](https://github.com/NREL/resstock/tree/develop/project_national/resources/options_saturations.csv), [options_lookup](https://github.com/NREL/resstock/blob/develop/resources/options_lookup.tsv).
-- [ ] Changelog has been updated
+- [ ] Add to the [changelog_dev.rst file](https://github.com/NREL/resstock/tree/develop/docs/read_the_docs/source/changelog/changelog_dev.rst)
 - [ ] `openstudio tasks.rb update_measures` has been run
 - [ ] No unexpected regression test changes on CI (checked comparison artifacts)

.github/workflows/config.yml

@@ -363,6 +363,7 @@ jobs:
           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
+          pip install changelog
           make html SPHINXOPTS="-W --keep-going -n"
 
       - name: Save Docs

docs/read_the_docs/source/changelog/changelog_1_0_0.rst

@@ -0,0 +1,8 @@
+================
+v1.0.0 Changelog
+================
+
+.. changelog::
+    :version: v1.0.0
+    :released: 2019-04-17
+

docs/read_the_docs/source/changelog/changelog_2_0_0.rst

@@ -0,0 +1,189 @@
+================
+v2.0.0 Changelog
+================
+
+.. changelog::
+    :version: v2.0.0
+    :released: 2019-04-17
+
+    .. change::
+        :tags: software, openstudio, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Update to OpenStudio v2.8.0.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Add a multifamily project which includes housing characteristic distributions for single-family detached, single-family attached, and multifamily buildings.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Add measures for calculating construction properties, modeling power outages and calculating resilience metrics, and calculating utility bills.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Add measure for modeling shared multiifamily facades using adiabatic constructions.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Relocate all measure unit tests, test osw files, and test osm files from archived OpenStudio-BEopt and into this repository.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Create example workflow osw files for single-family detached, single-family attached, and multifamily buildings using TMY weather.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, bugfix
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Reporting measures read from ReportMeterData table to get disaggregated fan and pump energy.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, bugfix
+        :pullreq: 151
+
+        **Date**: 2019-04-11
+
+        Title:
+        Multifamily
+
+        Description:
+        Break out central system heating, cooling, and pump energy in reporting measures.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+
+    .. change::
+        :tags: workflow, mechanics, bugfix
+        :pullreq: 216
+
+        **Date**: 2019-03-21
+
+        Title:
+        Use UnitConversions.convert(...) method
+
+        Description:
+        Use custom unit conversions script instead of that provided by OpenStudio SDK.
+
+        Assignees: Joe Robertson
+
+
+    .. change::
+        :tags: workflow, documentation, feature
+        :pullreq: 211
+
+        **Date**: 2019-02-28
+
+        Title:
+        Dependency graphs and wheels
+
+        Description:
+        Automatically generate dependency graphs and a dependency wheel for each project.
+        I put together scripts in the docs folder to automatically generate dependency graphs and a dependency wheel for each <project_folder> in the OpenStudio-BuildStock repository. These scripts create a util folder if it doesn't exist and puts data for these visualizations. A project README.md file has been added to each <project_folder> where there is a link to the interactive dependency wheel. These visualizations are easily updated as they depend strictly on the TSV files. They are updated through a single regenerate_visualization.ipynb script.
+
+        Assignees: Anthony Fontanini
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 206
+
+        **Date**: 2019-02-12
+
+        Title:
+        Large buildings collapsed into minimal units
+
+        Description:
+        Ability to simulate large multifamily buildings using "collapsed" buildings with multipliers on building units.
+
+        Assignees: Joe Robertson
+
+
+    .. change::
+        :tags: workflow, mechanics, feature
+        :pullreq: 151
+
+        **Date**: NaT
+
+        Title:
+        Multifamily
+
+        Description:
+        Ability to add central systems (boiler with baseboards, fan coil, PTAC) to multifamily buildings using the openstudio-standards gem.
+
+        Assignees: Joe Robertson, Maharshi Pathak, Scott Horowitz
+
+