-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove some options that are set for default values. Remove nice_name and let Documenter use the title of the page. Remove link_check=false to make Documenter run the link checker. Closes #357
- Loading branch information
1 parent
20f119e
commit e5265e7
Showing
2 changed files
with
7 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,30 +5,16 @@ DocMeta.setdocmeta!(BestieTemplate, :DocTestSetup, :(using BestieTemplate); recu | |
|
||
const page_rename = Dict("developer.md" => "Developer docs") # Without the numbers | ||
|
||
function nice_name(file) | ||
file = replace(file, r"^[0-9]*-" => "") | ||
if haskey(page_rename, file) | ||
return page_rename[file] | ||
end | ||
return splitext(file)[1] |> x -> replace(x, "-" => " ") |> titlecase | ||
end | ||
|
||
makedocs(; | ||
modules = [BestieTemplate], | ||
doctest = true, | ||
linkcheck = false, # Rely on Lint.yml/lychee for the links | ||
authors = "Abel Soares Siqueira <[email protected]> and contributors", | ||
repo = "https://github.com/abelsiqueira/BestieTemplate.jl/blob/{commit}{path}#{line}", | ||
sitename = "BestieTemplate.jl", | ||
format = Documenter.HTML(; | ||
prettyurls = true, | ||
canonical = "https://abelsiqueira.github.io/BestieTemplate.jl", | ||
assets = ["assets/style.css"], | ||
), | ||
format = Documenter.HTML(; canonical = "https://abelsiqueira.github.io/BestieTemplate.jl"), | ||
pages = [ | ||
"Home" => "index.md" | ||
"index.md" | ||
[ | ||
nice_name(file) => file for | ||
file for | ||
file in readdir(joinpath(@__DIR__, "src")) if file != "index.md" && splitext(file)[2] == ".md" | ||
] | ||
], | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters