Skip to content

Commit

Permalink
Improved documentation building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
brainandforce committed Mar 19, 2024
1 parent 759452f commit 7977049
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@ using Documenter

DocMeta.setdocmeta!(CliffordNumbers, :DocTestSetup, :(using CliffordNumbers); recursive=true)

is_ci_env = (get(ENV, "CI", nothing) == true)
@info "is_ci_env == $is_ci_env"

makedocs(;
modules=[CliffordNumbers],
authors="Brandon Flores",
repo="https://github.com/brainandforce/CliffordNumbers.jl/blob/{commit}{path}#{line}",
sitename="CliffordNumbers.jl",
modules=[CliffordNumbers],
checkdocs = :exports,
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://brainandforce.github.io/CliffordNumbers.jl",
edit_link="main",
assets=String[],
prettyurls = is_ci_env,
canonical = "https://brainandforce.github.io/CliffordNumbers.jl",
edit_link = "main",
assets = String[],
),
pages=[
"Home" => "index.md",
"API" => "api.md"
],
)

Expand Down

0 comments on commit 7977049

Please sign in to comment.