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

Backports for 0.22.5 #1056

Merged
merged 6 commits into from
Jul 3, 2019
Merged

Backports for 0.22.5 #1056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
98acad3
Add Random as test. dep (#1037)
mortenpi Jun 13, 2019
cb60329
Update analytics ID (#1042)
mortenpi Jun 24, 2019
299e067
Disable linkcheck tests
mortenpi Jul 3, 2019
2d7afce
Allow passing ARGS via env.vars to docs/make.jl
mortenpi Jul 1, 2019
1e9c615
Add CHANGELOG for 0.22.5
mortenpi Jul 3, 2019
d51ea8a
Set version to 0.22.5
mortenpi Jul 3, 2019
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Documenter.jl changelog

## Version `v0.22.5`

* ![Maintenance][badge-maintenance] Fix a test dependency problem revealed by a bugfix in Julia / Pkg. ([#1037][github-1037])

## Version `v0.22.4`

* ![Bugfix][badge-bugfix] Documenter no longer crashes if the build includes doctests from docstrings that are defined in files that do not exist on the file system (e.g. if a Julia Base docstring is included when running a non-source Julia build). ([#1002][github-1002])
Expand Down Expand Up @@ -315,6 +319,7 @@
[github-1004]: https://github.com/JuliaDocs/Documenter.jl/pull/1004
[github-1009]: https://github.com/JuliaDocs/Documenter.jl/pull/1009
[github-1014]: https://github.com/JuliaDocs/Documenter.jl/pull/1014
[github-1037]: https://github.com/JuliaDocs/Documenter.jl/pull/1037

[documenterlatex]: https://github.com/JuliaDocs/DocumenterLaTeX.jl
[documentermarkdown]: https://github.com/JuliaDocs/DocumenterMarkdown.jl
Expand All @@ -327,6 +332,7 @@
[badge-enhancement]: https://img.shields.io/badge/enhancement-blue.svg
[badge-bugfix]: https://img.shields.io/badge/bugfix-purple.svg
[badge-security]: https://img.shields.io/badge/security-black.svg
[badge-maintenance]: https://img.shields.io/badge/maintenance-gray.svg

<!--
# Badges
Expand All @@ -337,4 +343,5 @@
![Enhancement][badge-enhancement]
![Bugfix][badge-bugfix]
![Security][badge-security]
![Maintenance][badge-maintenance]
-->
5 changes: 3 additions & 2 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "Documenter"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.22.4"
version = "0.22.5"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand All @@ -20,6 +20,7 @@ JSON = "0.19, 0.20"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[targets]
test = ["Test"]
test = ["Test", "Random"]
13 changes: 11 additions & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
using Documenter, DocumenterTools

# The DOCSARGS environment variable can be used to pass additional arguments to make.jl.
# This is useful on CI, if you need to change the behavior of the build slightly but you
# can not change the .travis.yml or make.jl scripts any more (e.g. for a tag build).
if haskey(ENV, "DOCSARGS")
for arg in split(ENV["DOCSARGS"])
push!(ARGS, arg)
end
end

makedocs(
modules = [Documenter, DocumenterTools],
format = Documenter.HTML(
# Use clean URLs, unless built as a "local" build
prettyurls = !("local" in ARGS),
canonical = "https://juliadocs.github.io/Documenter.jl/stable/",
assets = ["assets/favicon.ico"],
analytics = "UA-89508993-1",
analytics = "UA-136089579-2",
),
clean = false,
sitename = "Documenter.jl",
Expand Down Expand Up @@ -49,7 +58,7 @@ makedocs(
],
"contributing.md",
],
strict = true,
strict = !("strict=false" in ARGS),
)

deploydocs(
Expand Down
5 changes: 3 additions & 2 deletions test/docchecks.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ using Documenter.DocChecks: linkcheck
using Documenter.Documents

@testset "DocChecks" begin
# The linkcheck tests are currently not reliable on CI, so they are disabled.
@testset "linkcheck" begin
src = md"""
[HTTP (HTTP/1.1) success](http://www.google.com)
Expand All @@ -20,7 +21,7 @@ using Documenter.Documents
Documents.walk(Dict{Symbol, Any}(), src) do block
doc = Documents.Document(; linkcheck=true)
result = linkcheck(block, doc)
@test doc.internal.errors == Set{Symbol}()
@test_skip doc.internal.errors == Set{Symbol}()
result
end

Expand All @@ -29,7 +30,7 @@ using Documenter.Documents
Documents.walk(Dict{Symbol, Any}(), src) do block
linkcheck(block, doc)
end
@test doc.internal.errors == Set{Symbol}([:linkcheck])
@test_skip doc.internal.errors == Set{Symbol}([:linkcheck])
end
end

Expand Down