Merge pull request #345 from SpeedyWeather/ncc/run-example-in-docs

Run examples and produce output with every Docs built

.gitignore

@@ -19,6 +19,9 @@ deps/src/
 docs/build/
 docs/site/
 
+# PythonCall added .CondaPkg to /docs
+docs/.CondaPkg
+
 # File generated by Pkg, the package manager, based on a corresponding Project.toml
 # It records a fixed state of all packages used by the project. As such, it should not be
 # committed for packages, but should be committed for applications that require a static
@@ -32,4 +35,4 @@ Manifest.toml
 run_*/
 
 # no video outputs
-*.mp4
+*.mp4

docs/Project.toml

@@ -1,7 +1,11 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+NCDatasets = "85f8d34a-cbdd-5861-8df4-14fed0d494ab"
+PythonPlot = "274fc56d-3b97-40fa-a1cd-1b4a50311bf9"
 UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 
 [compat]
 Documenter = "0.26, 0.27"
-UnicodePlots = "^3.3"
+NCDatasets = "0.12"
+UnicodePlots = "^3.3"
+PythonPlot = "1"

docs/make.jl

@@ -1,8 +1,8 @@
 using Documenter, SpeedyWeather
 
 makedocs(
-    format=Documenter.HTML(prettyurls=get(ENV, "CI", nothing)=="true",
-    ansicolor=true),
+     format=Documenter.HTML(prettyurls=get(ENV, "CI", nothing)=="true",
+                            ansicolor=true),
     sitename="SpeedyWeather.jl",
     authors="M Klöwer and SpeedyWeather contributors",
     modules=[SpeedyWeather],
@@ -20,8 +20,6 @@ makedocs(
             "Submodule: RingGrids"=>"ringgrids.md",
             "Submodule: LowerTriangularMatrices"=>"lowertriangularmatrices.md",
             "Submodule: SpeedyTransforms"=>"speedytransforms.md",
-            "Style and convention guide"=>"conventions.md",
-            "Development notes"=>"development.md",
             "Function and type index"=>"functions.md"]
 )