Skip to content

Commit

Permalink
Move requiredmods back to pages.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
abhro committed Jun 19, 2024
1 parent 092711c commit ad4fb33
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -25,8 +24,6 @@ setup = quote
end
DocMeta.setdocmeta!(AstroImages, :DocTestSetup, setup; recursive = true)

include("pages.jl")

makedocs(
sitename = "AstroImages.jl",
pages = pages,
Expand All @@ -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
Expand Down
11 changes: 11 additions & 0 deletions docs/pages.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
]

0 comments on commit ad4fb33

Please sign in to comment.