diff --git a/docs/make.jl b/docs/make.jl index 61d2c59e..0e693551 100755 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,14 +1,32 @@ -using Documenter, RealNeuralNetworks +using Documenter +using RealNeuralNetworks using RealNeuralNetworks.Neurons using RealNeuralNetworks.Neurons.Segments using RealNeuralNetworks.Neurons.Segments.Synapses using RealNeuralNetworks.SWCs +# 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"]) + (arg in ARGS) || push!(ARGS, arg) + end +end + makedocs( modules=[RealNeuralNetworks, Neurons, Segments, Synapses, SWCs], sitename="RealNeuralNetworks.jl", authors="Jingpeng Wu", - format=:html, + format = Documenter.HTML( + # Use clean URLs, unless built as a "local" build + prettyurls = !("local" in ARGS), + canonical = "https://seung-lab.github.io/RealNeuralNetworks.jl/latest/", + assets = ["assets/favicon.ico"], + analytics = "UA-136089579-2", + highlights = ["yaml"], + ), + linkcheck = !("skiplinks" in ARGS), pages = [ "Home" => "index.md", "Manual" => Any[ @@ -26,15 +44,11 @@ makedocs( ], "man/contributing.md", ], - # use clean URLs, unless built as a "local" build - html_prettyurls = !("local" in ARGS), - html_canonical = "https://seung-lab.github.io/RealNeuralNetworks.jl/latest", ) deploydocs( repo="github.com/seung-lab/RealNeuralNetworks.jl", target="build", - julia="0.7", deps=nothing, make=nothing )