Fix docs for retrofit

GenXProject · Mar 18, 2024 · 38b84c6 · 38b84c6
1 parent 8239c57
commit 38b84c6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 23 deletions.
diff --git a/docs/src/Model_Reference/Resources/retrofit.md b/docs/src/Model_Reference/Resources/retrofit.md
@@ -1,5 +1,5 @@
-## Retrofit
-
-```@docs
-GenX.retrofit
+# Retrofit
+```@autodocs
+Modules = [GenX]
+Pages = ["retrofits.jl"]
 ```
diff --git a/docs/src/User_Guide/multi_stage_input.md b/docs/src/User_Guide/multi_stage_input.md
@@ -59,11 +59,11 @@ Instead of one set of input files, there is one directory of input files that ne
 | Capital\_Recovery\_Period   | The line-specific period in years over which initial capital costs must be recovered.                                                                |
 | WACC                      | The line-specific weighted average cost of capital.                                                                                                  |
 
-!!! note "Allowing retrofitting capacity to not contribute to minimum retirement requirements (`myopic=0` only)"
+!!! note "Allowing retrofitted capacity to not contribute to minimum retirement requirements (`myopic=0` only)"
     Special considerations must be taken into account when utilizing the retrofit module alongside multi-stage planning, particularly when using a non zero value for the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file.
-    1. When assigning a non-zero value to the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file, the user can specify whether the model should consider the retrofitting capacity to contribute to the minimum retirement requirement. This is done by setting the `Contribute_Min_Retirement` column to 1 for the retrofit options in the same retrofit cluster (i.e., same `Retrofit_Id`).
-    2. By default, the model assumes that retrofitting capacity contributes to fulfilling minimum retirement requirements.
-    3. Should users wish to exclude retrofitting capacity from contributing to minimum retirement requirements, they must set the `Contribute_Min_Retirement` column to 0 for **all** retrofit options within the same retrofit cluster (i.e., sharing the same `Retrofit_Id`).
+    1. When assigning a non-zero value to the `Min_Retired_Cap_MW` column in the `Resource_multistage_data.csv` file, the user can specify whether the model should consider the retrofitted capacity to contribute to the minimum retirement requirement. This is done by setting the `Contribute_Min_Retirement` column to 1 for the retrofit options in the same retrofit cluster (i.e., same `Retrofit_Id`).
+    2. By default, the model assumes that retrofitted capacity contributes to fulfilling minimum retirement requirements.
+    3. Should users wish to exclude retrofitted capacity from contributing to minimum retirement requirements, they must set the `Contribute_Min_Retirement` column to 0 for **all** retrofit options within the same retrofit cluster (i.e., sharing the same `Retrofit_Id`).
     4. It's important to note that this additional functionality is not currently supported when `myopic=1`. In this case, the retrofit options are only allowed to contribute to the minimum retirement requirement.
 
     Example 1: Retrofitted capacity is allowed to contribute to the minimum retirement requirement (i.e., retrofit options in the same cluster (`Retrofit_Id = 1`) all have `Contribute_Min_Retirement = 1`):

diff --git a/test/retrofit/README.md b/test/retrofit/README.md