Skip to content

Commit 21deec2

Browse files
authored
Merge pull request #598 from Sienna-Platform/dt/fix-docs-extrefs
Fix broken @extref links breaking the docs build
2 parents 030ee94 + 8429356 commit 21deec2

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/src/docs_best_practices/how-to/troubleshoot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Pkg.add(["PowerSystems"]);
8282
2. Run the formatter once to format the rest of the file
8383
3. Add the text back in
8484
4. Add the `ignore` keyword argument with the file name to
85-
[`JuliaFormatter.format`](@extref `JuliaFormatter.format-Tuple{Any}`) in `scripts/formatter/formatter_code.jl`
85+
[`JuliaFormatter.format`](@extref JuliaFormatter.format) in `scripts/formatter/formatter_code.jl`
8686
to skip the file in the future:
8787

8888
```julia

docs/src/docs_best_practices/how-to/write_a_tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Sienna.
1010
the [difference between a tutorial and how-to guide](https://diataxis.fr/tutorials-how-to/)
1111
to refresh your memory and refer back throughout the process.
1212
- Look at an example: `PowerSystems.jl`'s
13-
[Working with Time Series](https://sienna-platform.github.io/PowerSystems.jl/stable/tutorials/working_with_time_series/)
13+
[Working with Time Series](@extref PowerSystems :doc:`tutorials/generated_working_with_time_series`)
1414

1515
!!! warning
1616

@@ -56,7 +56,7 @@ code blocks.
5656
!!! tip "Do"
5757

5858
Display all code, starting from `using SomeSiennaPackage`. Example: See
59-
[Working with Time Series](@extref tutorial_time_series).
59+
[Working with Time Series](@extref PowerSystems :doc:`tutorials/generated_working_with_time_series`).
6060

6161
!!! warning "Don't"
6262

0 commit comments

Comments
 (0)