Merge branch 'sort-reference-docs' of https://github.com/JoshuaLamper…

…t/DispersiveShallowWater.jl into sort-reference-docs

docs/make.jl

@@ -16,10 +16,12 @@ lines = readlines(ref_path)
 open(ref_path, "w") do io
     for line in lines
         if contains(line, "EQUATIONS_FILES_TO_BE_INSERTED")
-            line = replace(line, "EQUATIONS_FILES_TO_BE_INSERTED" => EQUATIONS_FILES_TO_BE_INSERTED)
+            line = replace(line,
+                           "EQUATIONS_FILES_TO_BE_INSERTED" => EQUATIONS_FILES_TO_BE_INSERTED)
         end
         if contains(line, "CALLBACKS_STEP_FILES_TO_BE_INSERTED")
-            line = replace(line, "CALLBACKS_STEP_FILES_TO_BE_INSERTED" => CALLBACKS_STEP_FILES_TO_BE_INSERTED)
+            line = replace(line,
+                           "CALLBACKS_STEP_FILES_TO_BE_INSERTED" => CALLBACKS_STEP_FILES_TO_BE_INSERTED)
         end
         println(io, line)
     end

src/DispersiveShallowWater.jl

@@ -2,10 +2,13 @@
     DispersiveShallowWater
 
 **DispersiveShallowWater.jl** is a Julia package that implements structure-preserving numerical methods for dispersive shallow water models.
-It provides provably conservative, entropy-conserving and well-balanced numerical schemes for some dispersive shallow water models.
+It provides provably conservative, entropy-conserving, and well-balanced numerical schemes for some dispersive shallow water models.
 
-The semidiscretizations are based on summation-by-parts (SBP) operators, which are implemented in SummationByPartsOperators.jl. To
-obtain fully discrete schemes, the time integration methods from OrdinaryDiffEq.jl are used to solve the resulting ordinary differential equations.
+The semidiscretizations are based on summation-by-parts (SBP) operators, which are implemented in 
+[SummationByPartsOperators.jl](https://github.com/ranocha/SummationByPartsOperators.jl). To
+obtain fully discrete schemes, the time integration methods from 
+[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl)
+are used to solve the resulting ordinary differential equations.
 Fully discrete entropy-conservative methods can be obtained by using the relaxation method provided by DispersiveShallowWater.jl.
 
 See also: [DispersiveShallowWater.jl](https://github.com/JoshuaLampert/DispersiveShallowWater.jl)

src/equations/svaerd_kalisch_1d.jl

@@ -338,10 +338,8 @@ end
 
 Return the modified total energy of the primitive variables `q_global` for the
 [`SvaerdKalischEquations1D`](@ref). It contains an additional term containing a
-derivative compared to the usual `energy_total`. The `energy_total_modified`
-is a conserved quantity of the Svärd-Kalisch equations.
-
-The total energy is given by
+derivative compared to the usual [`energy_total`](@ref). The `energy_total_modified`
+is a conserved quantity of the Svärd-Kalisch equations given by
 ```math
 \\frac{1}{2} g h^2 + \\frac{1}{2} h v^2 + \\frac{1}{2} \\hat\\beta v_x^2.
 ```