Skip plots_post_processing in docs, because Python broken on Github CI

mabarnes · Jan 20, 2025 · c51ce1f · c51ce1f
1 parent ced00b8
commit c51ce1f
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 7 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,7 +4,7 @@ Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
 Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 makie_post_processing = "4dd1b173-c370-4c56-9cc2-d797e41ae9f0"
 moment_kinetics = "b5ff72cc-06fc-4161-ad14-dba1c22ed34e"
-plots_post_processing = "c3e9b6e6-652c-46aa-9ac0-1bc582aad122"
+#plots_post_processing = "c3e9b6e6-652c-46aa-9ac0-1bc582aad122"
 
 [compat]
 Documenter = "0.27"
diff --git a/docs/make-pdf.jl b/docs/make-pdf.jl
@@ -14,12 +14,13 @@ 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
 using Glob
-using moment_kinetics, makie_post_processing, plots_post_processing
+using moment_kinetics, makie_post_processing#, plots_post_processing
 
 doc_files = glob("src/*.md")
 
@@ -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
 )
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,11 +3,12 @@ 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
-using moment_kinetics, makie_post_processing, plots_post_processing
+using moment_kinetics, makie_post_processing#, plots_post_processing
 
 if get(ENV, "CI", nothing) == "true"
     # On the CI, run in strict mode to turn warnings into errors, so that we don't deploy
@@ -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,
 )
 

diff --git a/docs/src/zz_plot_MMS_sequence.md b/docs/src/zz_plot_MMS_sequence.md
@@ -1,6 +1,8 @@
 `plot_MMS_sequence`
 ===================
 
+````
 ```@autodocs
 Modules = [plots_post_processing.plot_MMS_sequence]
 ```
+````
diff --git a/docs/src/zz_plot_sequence.md b/docs/src/zz_plot_sequence.md
@@ -1,6 +1,8 @@
 `plot_sequence`
 ===============
 
+````
 ```@autodocs
 Modules = [plots_post_processing.plot_sequence]
 ```
+````
diff --git a/docs/src/zz_plots_post_processing.md b/docs/src/zz_plots_post_processing.md
@@ -1,6 +1,15 @@
 `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 that comment out the `@autodocs` block below, in
+`docs/src/zz_plot_sequence.md` and in `docs/src/zz_plot_MMS_sequence.md`, and
+uncomment the lines  with `plots_post_processing` in `docs/make.jl`,
+`docs/make-pdf.jl`, and `docs/Project.toml`.
+````
 ```@autodocs
 Modules = [plots_post_processing, plots_post_processing.post_processing_input, plots_post_processing.shared_utils]
 ```
+````