Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make docs build warnings into errors #950

Merged
merged 4 commits into from
Jun 24, 2022
+4 −42
Merged

Make docs build warnings into errors #950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80f4c15
Update docs build job.
joseph-robertson Jun 24, 2022
b7db0d0
Update language from none to en.
joseph-robertson Jun 24, 2022
0ddb590
Merge branch 'develop' into docs-warnings
joseph-robertson Jun 24, 2022
837e60a
Remove old todo items.
joseph-robertson Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
- name: Build documentation
run: |
cd docs/read_the_docs
make html
make html SPHINXOPTS="-W --keep-going -n"

- name: Save Docs
uses: actions/upload-artifact@v2
Expand Down
2 changes: 1 addition & 1 deletion docs/read_the_docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
8 changes: 0 additions & 8 deletions docs/read_the_docs/source/upgrade_scenario_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@ Or say we want to apply the upgrade only to houses with 3 car garages that aren'
.. code::

(!Location Census Division|New England)&&(Geometry Garage|3 Car)

.. todo::

Come up with some better examples here.

Currently, you can enter up to 25 options per upgrade. To allow additional options per upgrade you would need to update a method defined in a resource file, run a rake task, and update the outputs section for all PAT projects. See :doc:`../advanced_tutorial/increasing_upgrade_options` for more information.

Expand Down Expand Up @@ -87,7 +83,3 @@ Package Apply Logic
===================

This is where to specifiy logic to determine whether the whole package of upgrades is applied (all of the options together). It uses the same format as :ref:`apply-logic`.

.. todo::

An example of when this might be useful would be nice.
34 changes: 2 additions & 32 deletions measures/UpgradeCosts/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.0</schema_version>
<name>upgrade_costs</name>
<uid>ef51212c-acc4-48d7-9b29-cf2a5c6c4449</uid>
<version_id>5fed18e3-1dd5-41d5-b14d-eb30e8108558</version_id>
<version_modified>20220623T181623Z</version_modified>
<version_id>f69ef381-9e5b-474b-9698-f1d7f940b929</version_id>
<version_modified>20220624T204207Z</version_modified>
<xml_checksum>9BF1E6AC</xml_checksum>
<class_name>UpgradeCosts</class_name>
<display_name>Upgrade Costs</display_name>
Expand Down Expand Up @@ -183,35 +183,5 @@
<usage_type>script</usage_type>
<checksum>F60D925A</checksum>
</file>
<file>
<filename>in.epw</filename>
<filetype>epw</filetype>
<usage_type>test</usage_type>
<checksum>E23378AA</checksum>
</file>
<file>
<filename>in.osm</filename>
<filetype>osm</filetype>
<usage_type>test</usage_type>
<checksum>241A86F8</checksum>
</file>
<file>
<filename>in.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>08698EDB</checksum>
</file>
<file>
<filename>SFD_1story_FB_UA_GRG_MSHP_FuelTanklessWH.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>08AE90A6</checksum>
</file>
<file>
<filename>SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH.xml</filename>
<filetype>xml</filetype>
<usage_type>test</usage_type>
<checksum>59D4FA96</checksum>
</file>
</files>
</measure>