Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add index.html generation for redirecting to ./stable or ./dev #1657

Merged
merged 15 commits into from
Aug 1, 2021
Merged

Add index.html generation for redirecting to ./stable or ./dev #1657

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c4086b6
add generation of index.html to redirect to ./stable or ./dev
hyrodium Jul 22, 2021
e8dd72c
Merge branch 'master' of https://github.com/JuliaDocs/Documenter.jl i…
hyrodium Jul 24, 2021
ab036cb
update generate_redirect_file to check generated comment
hyrodium Jul 24, 2021
30676a6
add tests for generate_redirect_file
hyrodium Jul 24, 2021
5e6b7fa
remove isnothing for Julia 1.0
hyrodium Jul 25, 2021
4e581c6
update redirected destination
hyrodium Jul 28, 2021
e40fd6d
fix test for generate_redirect_file
hyrodium Jul 28, 2021
e3d110f
Merge branch 'master' into feature/redirect
hyrodium Jul 30, 2021
6bac04d
update CHANGELOG.md
hyrodium Jul 30, 2021
dd5f1e1
add links in CHANGELOG.md
hyrodium Jul 30, 2021
0f19ae7
update tests
hyrodium Jul 30, 2021
959a69a
remove typo
hyrodium Jul 30, 2021
697576b
Update CHANGELOG.md
fredrikekre Jul 30, 2021
eba6ff0
Update CHANGELOG.md
mortenpi Aug 1, 2021
6b50cb0
Merge branch 'master' into feature/redirect
mortenpi Aug 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Documenter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,10 @@ function git_push(
# This must always happen after the folder copying.
Writers.HTMLWriter.generate_version_file(joinpath(dirname, "versions.js"), entries, symlinks)

# Create the index.html file to redirect ./stable or ./dev.
# This must always happen after the folder copying.
Writers.HTMLWriter.generate_redirect_file(joinpath(dirname, "index.html"), entries)

# generate the symlinks, make sure we don't overwrite devurl
cd(dirname) do
for kv in symlinks
Expand Down
14 changes: 14 additions & 0 deletions src/Writers/HTMLWriter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1405,6 +1405,20 @@ function generate_version_file(versionfile::AbstractString, entries, symlinks =
end
end

# write redirect file
function generate_redirect_file(redirectfile::AbstractString, entries)
# The link to the redirected destination is same as outdated-warning. (DOCUMENTER_STABLE)

comment = "<!--This file is automatically generated by Documenter.jl-->"

isfile(redirectfile) && !startswith(read(redirectfile, String), comment) && return

open(redirectfile, "w") do buf
println(buf, comment)
println(buf, "<meta http-equiv=\"refresh\" content=\"0; url=./$(first(entries))/\"/>")
end
end

function generate_siteinfo_file(dir::AbstractString, version::AbstractString)
open(joinpath(dir, "siteinfo.js"), "w") do buf
println(buf, "var DOCUMENTER_CURRENT_VERSION = \"$(version)\";")
Expand Down
19 changes: 18 additions & 1 deletion test/htmlwriter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module HTMLWriterTests
using Test
using Documenter
using Documenter: DocSystem
using Documenter.Writers.HTMLWriter: HTMLWriter, generate_version_file, expand_versions
using Documenter.Writers.HTMLWriter: HTMLWriter, generate_version_file, generate_redirect_file, expand_versions

function verify_version_file(versionfile, entries)
@test isfile(versionfile)
Expand All @@ -16,6 +16,13 @@ function verify_version_file(versionfile, entries)
end
end

function verify_redirect_file(redirectfile, version)
@test isfile(redirectfile)
content = read(redirectfile, String)

@test occursin("url=./$(version)/", content)
end

@testset "HTMLWriter" begin
@test isdir(HTMLWriter.ASSETS)
@test isdir(HTMLWriter.ASSETS_SASS)
Expand Down Expand Up @@ -104,6 +111,8 @@ end

mktempdir() do tmpdir
versionfile = joinpath(tmpdir, "versions.js")
redirectfile = joinpath(tmpdir, "index.html")
devurl = "dev"
fredrikekre marked this conversation as resolved.
Show resolved Hide resolved
versions = ["stable", "dev",
"2.1.1", "v2.1.0", "v2.0.1", "v2.0.0",
"1.1.1", "v1.1.0", "v1.0.1", "v1.0.0",
Expand All @@ -124,6 +133,8 @@ end
"v1.1.1"=>"1.1.1", "v0.1.1"=>"0.1.1"]
generate_version_file(versionfile, entries)
verify_version_file(versionfile, entries)
generate_redirect_file(redirectfile, entries)
verify_redirect_file(redirectfile, "stable")

versions = ["v#"]
entries, symlinks = expand_versions(tmpdir, versions)
Expand All @@ -133,6 +144,8 @@ end
"v2.1.1"=>"2.1.1", "v1.1.1"=>"1.1.1", "v0.1.1"=>"0.1.1"]
generate_version_file(versionfile, entries)
verify_version_file(versionfile, entries)
generate_redirect_file(redirectfile, entries)
verify_redirect_file(redirectfile, "v2.1")

versions = ["v#.#.#"]
entries, symlinks = expand_versions(tmpdir, versions)
Expand All @@ -143,6 +156,8 @@ end
"v2.0"=>"v2.0.1", "v1.1"=>"1.1.1", "v1.0"=>"v1.0.1", "v0.1"=>"0.1.1"]
generate_version_file(versionfile, entries)
verify_version_file(versionfile, entries)
generate_redirect_file(redirectfile, entries)
verify_redirect_file(redirectfile, "v2.1.1")

versions = ["v^", "devel" => "dev", "foobar", "foo" => "bar"]
entries, symlinks = @test_logs(
Expand All @@ -155,6 +170,8 @@ end
@test ("devel" => "dev") in symlinks
generate_version_file(versionfile, entries)
verify_version_file(versionfile, entries)
generate_redirect_file(redirectfile, entries)
verify_redirect_file(redirectfile, "v2.1")

versions = ["stable" => "v^", "dev" => "stable"]
@test_throws ArgumentError expand_versions(tmpdir, versions)
Expand Down