Skip plots_post_processing in docs, because Python broken on Github CI

docs/make-pdf.jl

@@ -14,7 +14,8 @@ using Pkg
 repo_dir = dirname(dirname(@__FILE__))
 Pkg.develop([PackageSpec(path=joinpath(repo_dir, "moment_kinetics")),
              PackageSpec(path=joinpath(repo_dir, "makie_post_processing", "makie_post_processing")),
-             PackageSpec(path=joinpath(repo_dir, "plots_post_processing", "plots_post_processing"))])
+             #PackageSpec(path=joinpath(repo_dir, "plots_post_processing", "plots_post_processing"))
+            ])
 Pkg.instantiate()
 
 using Documenter
@@ -35,7 +36,10 @@ end
 makedocs(
     sitename = "momentkinetics",
     format = Documenter.LaTeX(; latex_kwargs...),
-    modules = [moment_kinetics, makie_post_processing, plots_post_processing],
+    modules = [moment_kinetics,
+               makie_post_processing,
+               #plots_post_processing
+              ],
     authors = "M. Barnes, J.T. Omotani, M. Hardman",
     pages = doc_files
 )

docs/make.jl

@@ -3,7 +3,8 @@ using Pkg
 repo_dir = dirname(dirname(@__FILE__))
 Pkg.develop([PackageSpec(path=joinpath(repo_dir, "moment_kinetics")),
              PackageSpec(path=joinpath(repo_dir, "makie_post_processing", "makie_post_processing")),
-             PackageSpec(path=joinpath(repo_dir, "plots_post_processing", "plots_post_processing"))])
+             #PackageSpec(path=joinpath(repo_dir, "plots_post_processing", "plots_post_processing")),
+            ])
 Pkg.instantiate()
 
 using Documenter
@@ -20,7 +21,10 @@ end
 makedocs(
     sitename = "moment_kinetics",
     format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
-    modules = [moment_kinetics, makie_post_processing, plots_post_processing],
+    modules = [moment_kinetics,
+               makie_post_processing,
+               #plots_post_processing
+              ],
     strict = strict,
 )
 

docs/src/zz_plots_post_processing.md

@@ -1,6 +1,14 @@
 `plots_post_processing`
 =======================
 
+As of 20/1/2025, importing `Plots` in the Github Actions CI causes an error, so
+for now we skip building the documentation for `plots_post_processing` as we
+cannot import the module without its `Plots` dependency. When this is fixed,
+remove the quadruple-backticks below that comment out the `@autodocs` block,
+and uncomment the lines  with `plots_post_processing` in `docs/make.jl` and
+`docs/make-pdf.jl`.
+````
 ```@autodocs
 Modules = [plots_post_processing, plots_post_processing.post_processing_input, plots_post_processing.shared_utils]
 ```
+````