You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
101 lines
4.1 KiB
101 lines
4.1 KiB
using Documenter |
|
using Literate |
|
# using Plots # to not capture precompilation output |
|
|
|
# # generate examples |
|
# EXAMPLE = joinpath(@__DIR__, "..", "examples", "example.jl") |
|
# OUTPUT = joinpath(@__DIR__, "src/generated") |
|
|
|
# function preprocess(str) |
|
# str = replace(str, "MYVARIABLE" => "z") |
|
# str = replace(str, "MYVALUE" => "1.0 + 2.0im") |
|
# return str |
|
# end |
|
|
|
# Literate.markdown(EXAMPLE, OUTPUT, preprocess = preprocess) |
|
# Literate.notebook(EXAMPLE, OUTPUT, preprocess = preprocess) |
|
# Literate.script(EXAMPLE, OUTPUT, preprocess = preprocess) |
|
|
|
# # generate the example notebook for the documentation, keep in sync with outputformats.md |
|
# Literate.markdown(joinpath(@__DIR__, "src/outputformats.jl"), OUTPUT; credit = false, name = "name") |
|
# Literate.notebook(joinpath(@__DIR__, "src/outputformats.jl"), OUTPUT, name = "notebook") |
|
# Literate.script(joinpath(@__DIR__, "src/outputformats.jl"), OUTPUT, credit = false) |
|
|
|
# # replace the link in outputformats.md |
|
# travis_tag = get(ENV, "TRAVIS_TAG", "") |
|
# folder = isempty(travis_tag) ? "latest" : travis_tag |
|
# url = "https://nbviewer.jupyter.org/github/fredrikekre/Literate.jl/blob/gh-pages/$(folder)/" |
|
# if get(ENV, "HAS_JOSH_K_SEAL_OF_APPROVAL", "") == "true" |
|
# str = read(joinpath(@__DIR__, "src/outputformats.md"), String) |
|
# str = replace(str, "[notebook.ipynb](generated/notebook.ipynb)." => "[notebook.ipynb]($(url)generated/notebook.ipynb).") |
|
# write(joinpath(@__DIR__, "src/outputformats.md"), str) |
|
# end |
|
|
|
|
|
# makedocs( |
|
# format = Documenter.HTML( |
|
# prettyurls = get(ENV, "CI", nothing) == "true", |
|
# assets = ["assets/custom.css"], |
|
|
|
# ), |
|
# modules = [Literate], |
|
# sitename = "Literate.jl", |
|
# pages = Any[ |
|
# "index.md", |
|
# "fileformat.md", |
|
# "pipeline.md", |
|
# "outputformats.md", |
|
# "customprocessing.md", |
|
# "documenter.md", |
|
# "generated/example.md"] |
|
# ) |
|
|
|
############################################ |
|
# Set up for pushing preview docs from PRs # |
|
############################################ |
|
# if haskey(ENV, "TRAVIS_PULL_REQUEST") && ENV["TRAVIS_PULL_REQUEST"] != "false" |
|
# @info "Pushing preview docs." |
|
# PR = ENV["TRAVIS_PULL_REQUEST"] |
|
# # Overwrite Documenter's function for generating the versions.js file |
|
# foreach(Base.delete_method, methods(Documenter.Writers.HTMLWriter.generate_version_file)) |
|
# Documenter.Writers.HTMLWriter.generate_version_file(_, _) = nothing |
|
# # Overwrite necessary environment variables to trick Documenter to deploy |
|
# ENV["TRAVIS_PULL_REQUEST"] = "false" |
|
# ENV["TRAVIS_BRANCH"] = "master" |
|
# deploydocs( |
|
# devurl = "preview-PR$(PR)", |
|
# repo = "github.com/fredrikekre/Literate.jl.git", |
|
# ) |
|
# exit(0) |
|
# end |
|
if get(ENV, "GITHUB_EVENT_NAME", nothing) == "pull_request" |
|
@info "Pushing preview docs." |
|
PR = match(r"refs\/pull\/(\d+)\/merge", ENV["GITHUB_REF"]).captures[1] |
|
# Overwrite Documenter's function for generating the versions.js file |
|
foreach(Base.delete_method, methods(Documenter.Writers.HTMLWriter.generate_version_file)) |
|
Documenter.Writers.HTMLWriter.generate_version_file(_, _) = nothing |
|
# Overwrite necessary environment variables to trick Documenter to deploy |
|
ENV["GITHUB_EVENT_NAME"] = "push" |
|
ENV["GITHUB_REF"] = "refs/heads/master" |
|
deploydocs( |
|
devurl = "preview-PR$(PR)", |
|
repo = "github.com/fredrikekre/Literate.jl.git", |
|
) |
|
# Add a comment on the PR with a link to the preview |
|
# TODO: URL available from JSON.parsefile(ENV["GITHUB..."])["pull_request"]["comments_url"] |
|
msg = "Documentation built successfully, a preview can be found here: https://fredrikekre.github.io/Literate.jl/preview-PR$(PR)" |
|
cmd = `curl -X POST` |
|
push!(cmd.exec, "-H", "Authorization: token $(ENV["GITHUB_TOKEN"])") |
|
push!(cmd.exec, "-H", "Content-Type: application/json") |
|
push!(cmd.exec, "-d", "'{\"body\":\"$(msg)\"}'") |
|
push!(cmd.exec, "https://api.github.com/repos/fredrikekre/Literate.jl/issues/$(PR)/comments") |
|
try |
|
success(cmd) |
|
catch |
|
end |
|
exit(0) |
|
end |
|
|
|
deploydocs( |
|
repo = "github.com/fredrikekre/Literate.jl.git", |
|
)
|
|
|