Run doctests in all tests (#95)

* Run doctests in all tests

* Fix broken doctests

* Load `Breeze` in `Main` to make doctests pass

Author: giordano

docs/src/contributing.md

@@ -44,6 +44,13 @@ import Pkg
 Pkg.test("Breeze"; test_args=`--verbose --jobs 2 moist_air atmosphere`)
 ```
 
+Similarly, to run only the doctests, you can use the command
+
+```julia
+import Pkg
+Pkg.test("Breeze"; test_args=`doctests`)
+```
+
 !!! note "List of tests"
 
     The names of the test jobs are the file names under the `test` directory, without the `.jl` extension, excluding the `runtests.jl` file.

src/AtmosphereModels/anelastic_formulation.jl

@@ -29,8 +29,8 @@ end
 const AnelasticModel = AtmosphereModel{<:AnelasticFormulation}
 
 function Base.summary(formulation::AnelasticFormulation)
-    p₀ = formulation.constants.base_pressure
-    θᵣ = formulation.constants.potential_temperature
+    p₀ = formulation.reference_state.base_pressure
+    θᵣ = formulation.reference_state.potential_temperature
     return string("AnelasticFormulation(p₀=", prettysummary(p₀),
                   ", θᵣ=", prettysummary(θᵣ), ")")
 end

src/AtmosphereModels/atmosphere_model.jl

@@ -90,7 +90,7 @@ AtmosphereModel{CPU, RectilinearGrid}(time = 0 seconds, iteration = 0)
 ├── advection scheme: WENO{3, Float64, Float32}(order=5)
 ├── tracers: ()
 ├── coriolis: Nothing
-└── microphysics: WarmPhaseSaturationAdjustment
+└── microphysics: Nothing
 ```
 
 References
@@ -206,4 +206,4 @@ function Base.show(io::IO, model::AtmosphereModel)
         "└── microphysics: ", Mic)
 end
 
-cell_advection_timescale(model::AtmosphereModel) = cell_advection_timescale(model.grid, model.velocities)
+cell_advection_timescale(model::AtmosphereModel) = cell_advection_timescale(model.grid, model.velocities)

src/Thermodynamics/thermodynamics_constants.jl

@@ -15,7 +15,7 @@ A struct representing an ideal gas with molar mass and specific heat capacity.
 dry_air = IdealGas(molar_mass=0.02897, heat_capacity=1005)
 
 # output
-"IdealGas{Float64}(molar_mass=0.02897, heat_capacity=1005)"
+IdealGas{Float64}(molar_mass=0.02897, heat_capacity=1005.0)
 ```
 """
 struct IdealGas{FT}

test/Project.toml

@@ -1,12 +1,14 @@
 [deps]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ExplicitImports = "7d51a73a-1435-4ff3-83d9-f097790105c7"
 Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
 ParallelTestRunner = "d3525ed8-44d0-4b2c-a655-542cee43accc"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Aqua = "0.8"
+Documenter = "1.15"
 ExplicitImports = "1.13"
 Oceananigans = "0.100"
 ParallelTestRunner = "2.0.1"

test/doctests.jl

@@ -0,0 +1,7 @@
+# Loading `Breeze` into `Main` is necessary to work around
+# <https://github.com/JuliaTesting/ParallelTestRunner.jl/issues/68>.
+@eval Main using Breeze
+using Documenter: DocMeta, doctest
+DocMeta.setdocmeta!(Main.Breeze, :DocTestSetup, :(using Breeze); recursive = true)
+
+doctest(Main.Breeze; manual = false)