Skip to content

Conversation

oxinabox
Copy link
Member

@oxinabox oxinabox commented Aug 11, 2020

Documenter marks linkcheck as experimental, and has it disabled by default.
Given removing it will just fix #101 and let us stop wasting time on it, not using an experimental feature seems like a good idea.

https://juliadocs.github.io/Documenter.jl/stable/lib/public/#Documenter.makedocs

Experimental keywords

In addition to standard arguments there is a set of non-finalized experimental keyword arguments. The behaviour of these may change or they may be removed without deprecation when a minor version changes (i.e. except in patch releases).

linkcheck – if set to true makedocs uses curl to check the status codes of external-pointing links, to make sure that they are up-to-date. The links and their status codes are printed to the standard output. If strict is also enabled then the build will fail if there are any broken (400+ status code) links. Default: false.

linkcheck_ignore allows certain URLs to be ignored in linkcheck. The values should be a list of strings (which get matched exactly) or Regex objects. By default nothing is ignored.

linkcheck_timeout configures how long curl waits (in seconds) for a link request to return a response before giving up. The default is 10 seconds.

Alternatively we could use linkcheck_ignore to just ingore the codecov one that keeps causing problems, or try a longer timeout.

Copy link

@BSnelling BSnelling left a comment

Choose a reason for hiding this comment

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

This seems like a good choice for the moment as linkcheck is categorised as experimental by Documenter.

@oxinabox oxinabox merged commit 461b19c into master Aug 24, 2020
@nickrobinson251 nickrobinson251 deleted the ox/nolinkcheck branch August 24, 2020 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Travis CI Documenter failure

2 participants