diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index a5db7221e..c6f2ae116 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -19,4 +19,4 @@ jobs: id: lychee uses: lycheeverse/lychee-action@v2 with: - args: "--verbose --no-progress --accept 200,203,503 --exclude-path ^target './**/*.md' './**/*.html'" + args: "--verbose --no-progress --accept 200,203,503 --exclude-path ^target --exclude-path ^book/404.html$ './**/*.md' './**/*.html'" diff --git a/.lycheeignore b/.lycheeignore index 8c3f75f3b..a1358272f 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -1,6 +1,9 @@ # For some reason these spurious links appear in some cargo doc-generated files ^file://.+/MUSE2/book/api/index\.html$ +# Some of these links give a 404, even though they're generated in the API docs. No idea why. +^https://docs.rs/erased-serde/ + # Times out on GitHub runner ^http://www.adobe.com diff --git a/docs/model/investment.md b/docs/model/investment.md index 2ee29bbaf..6dccf743a 100644 --- a/docs/model/investment.md +++ b/docs/model/investment.md @@ -3,10 +3,10 @@ This section details the investment and asset retention decision process, which is applied within -step 2 of the [overall MUSE2 workflow]. This process determines which new assets to build and -which existing assets to retain to meet system needs over time. In the overall workflow, dispatch -optimisation is used to identify *physical needs* by quantifying demand profiles for commodities of -interest. +step 2 of the [overall MUSE2 workflow][framework-overview]. This process determines which new assets +to build and which existing assets to retain to meet system needs over time. In the overall +workflow, dispatch optimisation is used to identify *physical needs* by quantifying demand profiles +for commodities of interest. ## Commodity prices @@ -23,7 +23,7 @@ the preceding MSY. When the `pricing_strategy` option is set to `scarcity_adjust shadow prices for each commodity adjusted to remove the impact of binding capacity constraints. Note: there is an option to iterate over each year so that investment decisions are based on -equilibrium prices in the _current year_, in what's referred to as the "[ironing-out loop]". +equilibrium prices in the _current year_, in what's referred to as the "[ironing-out loop][framework-overview]". In this case, \\( \lambda\_{c,r,t} \\) will reflect prices from previous iteration of the ironing-out loop. @@ -203,6 +203,5 @@ For each asset option: AFC \* cap_r + \sum_{t} act_t \* AC_t \\)), divided by the annual output \\( \sum_t act_t \\). -[overall MUSE2 workflow]: ./README.md#framework-overview +[framework-overview]: https://energysystemsmodellinglab.github.io/MUSE2/model/index.html#framework-overview [Dispatch Optimisation Formulation]: ./dispatch_optimisation.md -[ironing-out loop]: ./README.md#framework-overview