A tool for estimating the future energy use, carbon emissions, and capital and operating cost impacts of energy efficiency and demand flexibility technologies in the U.S. residential and commercial building sectors.
The Sphinx extlinks package enables the creation of external links that point to URLs with a common format using shortened text. The package effectively allows for custom, user-created interpreted text roles alongside defaults like :code: or :ref:.
This feature is used primarily in the "Heating and Cooling Load Components" section of the documentation to point to specific files on the GitHub repo using the custom role :repo_file:. Building and inspecting the documentation locally will yield the expected output, but building on Read the Docs yields (as an example):
/home/docs/checkouts/readthedocs.org/user_builds/scout-bto/checkouts/docs-rtd-theme-fix/docs/thermal_load_components.rst:6: ERROR: Unknown interpreted text role "repo_file".
This error is repeated for every use of :repo_file:. The resulting links in the compiled documentation do not work.
The Sphinx extlinks package enables the creation of external links that point to URLs with a common format using shortened text. The package effectively allows for custom, user-created interpreted text roles alongside defaults like
:code:or:ref:.This feature is used primarily in the "Heating and Cooling Load Components" section of the documentation to point to specific files on the GitHub repo using the custom role
:repo_file:. Building and inspecting the documentation locally will yield the expected output, but building on Read the Docs yields (as an example):This error is repeated for every use of
:repo_file:. The resulting links in the compiled documentation do not work.