Skip to content

Commit

Permalink
Merge pull request #1056 from JuliaDocs/backports-0.22.5
Browse files Browse the repository at this point in the history
Backports for 0.22.5
  • Loading branch information
mortenpi authored Jul 3, 2019
2 parents 946837e + d51ea8a commit 049b459
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
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
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
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
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

2 comments on commit 049b459

@mortenpi
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register branch=release-0.22

Release notes:

Maintenance release. The changes are documented in the CHANGELOG.md file.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/1741

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.22.5 -m "<description of version>" 049b459f10487c4f4ef4066343468c21f3267e42
git push origin v0.22.5

Please sign in to comment.