Upgrade to new Documenter #29470
Upgrade to new Documenter #29470
Conversation
|
You suggested at some point that we could test the Documenter master here for a while, before tagging. I think that is a good idea, so I'd merge like this for now, and then upgrade v0.20 when that is released in a follow-up PR. |
doc/make.jl
Outdated
| deps = nothing, | ||
| make = nothing, | ||
| devurl = "1.1-DEV", | ||
| versions = ["v#.#", "1.1-DEV" => "1.1-DEV"] |
There was a problem hiding this comment.
Will "v#.#" also create v1/? From the docs:
"v#.#": includes links to the latest documentation for each minor release cycle (i.e. v2.0, v1.1, v1.0, v0.1).
There was a problem hiding this comment.
Create as in create the symlink? Yes. Create as in included in the selector? No. As the code is now it will create this:
v1.0 (pointing to v1.0.1)
v0.7 (pointing to v0.7.0)
v0.6 (pointing to v0.6.4)
v0.5 (pointing to v0.5.2)
v0.4 (pointing to v0.4.7)
v0.3 (pointing to v0.3.12)
v1.1-DEV
There was a problem hiding this comment.
We should clarify the docs for versions a bit, to make it clear what symlinks it creates as well.
doc/make.jl
Outdated
| repo = "github.com/JuliaLang/julia.git", | ||
| target = "_build/html/en", | ||
| dirname = "en", | ||
| deps = nothing, | ||
| make = nothing, | ||
| devurl = "1.1-DEV", |
There was a problem hiding this comment.
Having this be lowercase would look better in the URL in my opinion (/en/1.1-dev/).
There was a problem hiding this comment.
We have
julia> VERSION
v"1.1.0-DEV.361"
though?
There was a problem hiding this comment.
They don't necessarily have to agree I'd say. In any case, I think it would be fine to have uppercase in the selector, but we can't separate it from what the URL is at the moment.
There was a problem hiding this comment.
but we can't separate it from what the URL is at the moment.
Why not? We can have devurl = "v1.1-dev" and "v1.1-DEV" => "v1.1-dev" in versions.
(cherry picked from commit a897365)
(cherry picked from commit a897365)
(cherry picked from commit a897365)
We should probably wait until Documenter v0.20 is tagged, but here is a WIP for that.
cc @mortenpi