Skip to content

Fix broken @extref links breaking the docs build #598

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

Merged
jd-lara merged 1 commit into from
Jul 26, 2026
Merged

Fix broken @extref links breaking the docs build #598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/src/docs_best_practices/how-to/troubleshoot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Pkg.add(["PowerSystems"]);
2. Run the formatter once to format the rest of the file
3. Add the text back in
4. Add the `ignore` keyword argument with the file name to
[`JuliaFormatter.format`](@extref `JuliaFormatter.format-Tuple{Any}`) in `scripts/formatter/formatter_code.jl`
[`JuliaFormatter.format`](@extref JuliaFormatter.format) in `scripts/formatter/formatter_code.jl`
to skip the file in the future:

```julia
Expand Down
4 changes: 2 additions & 2 deletions docs/src/docs_best_practices/how-to/write_a_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Sienna.
the [difference between a tutorial and how-to guide](https://diataxis.fr/tutorials-how-to/)
to refresh your memory and refer back throughout the process.
- Look at an example: `PowerSystems.jl`'s
[Working with Time Series](https://sienna-platform.github.io/PowerSystems.jl/stable/tutorials/working_with_time_series/)
[Working with Time Series](@extref PowerSystems :doc:`tutorials/generated_working_with_time_series`)

!!! warning

Expand Down Expand Up @@ -56,7 +56,7 @@ code blocks.
!!! tip "Do"

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

!!! warning "Don't"

Expand Down
Loading