Skip to content
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

Fix Sphinx warnings #6239

Merged
merged 1 commit into from
Feb 20, 2025
Merged

Fix Sphinx warnings #6239

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 benchmarks/advection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Benchmarks:
2. Rotate Shape (rotate_shape_supg.prm, rotate_shape_ev.prm)
Various shapes being rotated by 360 degrees by a fixed velocity

See [doc/advection.md](doc/advection.md) for details.
See [](doc/advection) for details.
2 changes: 1 addition & 1 deletion benchmarks/advection/doc/advection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Both benchmarks have the identical setup in the temperature and a
compositional field. The only difference is that the temperature equation
contains a (small) physical diffusion term.

**[Description of benchmark files](../README.md)**
**[Description of benchmark files](../README)**

```{figure-md} fig:benchmark-drop
<img src="drop.png" />
Expand Down
2 changes: 1 addition & 1 deletion benchmarks/rayleigh_taylor_instability/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This file can later be processed with the 'gnuplot_script'.
There is also the standalone input file `rayleigh_taylor_instability.prm` which
runs only one of the cases (isoviscous and lambda=256km).

See [doc/rayleigh_taylor_instability.md](doc/rayleigh_taylor_instability.md) for more information.
See [](doc/rayleigh_taylor_instability) for more information.
2 changes: 1 addition & 1 deletion benchmarks/rayleigh_taylor_instability/doc/rayleigh_taylor_instability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ file:
end


**[Description of benchmark files](../README.md)**
**[Description of benchmark files](../README)**

```{figure-md} fig:RTi_grids_a
<img src="grid.*" style="width:44.0%" />
Expand Down
2 changes: 1 addition & 1 deletion benchmarks/sinking_block/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ In order to run the benchmark for many resolution, density and viscosity combina
all the input files generated inside the triple loop.
The `sinking_block.prm` input file is the standalone prm file for the sinking block benchmark.

For more information see [doc/sinking_block.md](doc/sinking_block.md).
For more information see [](doc/sinking_block).
2 changes: 1 addition & 1 deletion benchmarks/sinking_block/doc/sinking_block.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ $\delta\rho=8,32,128~\text{ kg m}^{-3}$. Results are shown in
{numref}`fig:sinking_block2` and we indeed recover the expected trend with all data
points forming a single smooth line.

**[Description of benchmark files](../README.md)**
**[Description of benchmark files](../README)**

```{figure-md} fig:sinking_block1
<img src="dens_vel.png" style="width:60.0%" />
Expand Down