diff --git a/src/plugins/documenter.jl b/src/plugins/documenter.jl index e4b2d2f..d67e6c6 100644 --- a/src/plugins/documenter.jl +++ b/src/plugins/documenter.jl @@ -19,13 +19,13 @@ function gen_plugin(plugin::Documenter, template::Template, pkg_name::AbstractSt path = joinpath(template.path, pkg_name) docs_dir = joinpath(path, "docs", "src") mkpath(docs_dir) - if !isempty(plugin.css_files) + if !isempty(plugin.assets) mkpath(joinpath(docs_dir, "assets")) - for file in plugin.css_files + for file in plugin.assets cp(file, joinpath(docs_dir, "assets", basename(file))) end end - if isempty(plugin.css_files) + if isempty(plugin.assets) assets = "[]" else # We want something that looks like the following: @@ -36,7 +36,7 @@ function gen_plugin(plugin::Documenter, template::Template, pkg_name::AbstractSt const TAB = repeat(" ", 4) assets = "[\n" - for file in plugin.css_files + for file in plugin.assets assets *= """$(TAB^2)"assets/$file",\n""" end assets *= "$TAB]" diff --git a/src/plugins/githubpages.jl b/src/plugins/githubpages.jl index c20dd1e..3e95628 100644 --- a/src/plugins/githubpages.jl +++ b/src/plugins/githubpages.jl @@ -1,24 +1,23 @@ """ - GitHubPages(; documenter_assets::Vector{AbstractString}=String[]) -> GitHubPages + GitHubPages(; assets::Vector{AbstractString}=String[]) -> GitHubPages Add GitHubPages to a template's plugins to add Documenter.jl support via GitHub Pages. # Keyword Arguments -* `documenter_assets::Vector{String}=String[]`: Array of paths to Documenter asset files. +* `assets::Vector{String}=String[]`: Array of paths to Documenter asset files. """ -struct GitHubPages <: Documenter @auto_hash_equals struct GitHubPages <: Documenter gitignore_files::Vector{AbstractString} - documenter_assets::Vector{AbstractString} + assets::Vector{AbstractString} - function GitHubPages(; css_files::Vector{String}=String[]) - for file in documenter_assets + function GitHubPages(; assets::Vector{String}=String[]) + for file in assets if !isfile(file) throw(ArgumentError("Asset file $file does not exist")) end end # Windows Git recognizes these paths as well. - new(["/docs/build/", "/docs/site/"], documenter_assets) + new(["/docs/build/", "/docs/site/"], assets) end end