From ad4fb3385a7ea6da2ec7495609cec78d830af8ff Mon Sep 17 00:00:00 2001 From: Abhro R <5664668+abhro@users.noreply.github.com> Date: Tue, 18 Jun 2024 17:15:27 -0400 Subject: [PATCH] Move requiredmods back to pages.jl --- docs/make.jl | 16 +++++++--------- docs/pages.jl | 11 +++++++++++ 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 1b17b2af..bc84597f 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,15 +1,14 @@ -using Documenter, AstroImages +using Documenter +using AstroImages # Deps for examples ENV["GKSwstype"] = "nul" using Photometry, Reproject, Images -requiredmods = Symbol[ - :AstroImages, - # :Photometry, :Reproject, :Images - :Images, :FileIO, :DimensionalData, :ImageTransformations, :ImageFiltering, :WCS, :Plots -] +# gives us `pages` and `requiredmods` +include("pages.jl") + for mod in requiredmods eval(:(using $mod)) end @@ -25,8 +24,6 @@ setup = quote end DocMeta.setdocmeta!(AstroImages, :DocTestSetup, setup; recursive = true) -include("pages.jl") - makedocs( sitename = "AstroImages.jl", pages = pages, @@ -37,7 +34,8 @@ makedocs( workdir = "..", # Specify several modules since we want to include docstrings from functions we've extended - modules = [eval(mod) for mod in requiredmods],#[AstroImages, Images, FileIO, DimensionalData, WCS], + modules = [eval(mod) for mod in requiredmods], + #modules = [AstroImages, Images, FileIO, DimensionalData, WCS], # However we have to turnoff doctests since otherwise a failing test in # those other packages (e.g. caused by us not setting up their test diff --git a/docs/pages.jl b/docs/pages.jl index 3f4cb609..bc1c03b6 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -23,3 +23,14 @@ pages = [ ], "API" => "api.md", ] + + +# requiredmods is needed in pages.jl and not make.jl because the builder in +# JuliaAstro.github.io looks for this variable in pages.jl, and moving it +# breaks the documentation build process +requiredmods = Symbol[ + :AstroImages, + #:Photometry, :Reproject, :Images, + :Images, :FileIO, :DimensionalData, :ImageTransformations, :ImageFiltering, + :WCS, :Plots +]