From 4128610fb34f138c41fa55c557739c69db10a254 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Tue, 15 Oct 2019 01:24:26 +0200 Subject: [PATCH] jfkdsl --- docs/make.jl | 82 ++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index bb99c0b..0629cd2 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,54 +1,54 @@ using Documenter using Literate -# using Plots # to not capture precompilation output +using Plots # to not capture precompilation output -# # generate examples -# EXAMPLE = joinpath(@__DIR__, "..", "examples", "example.jl") -# OUTPUT = joinpath(@__DIR__, "src/generated") +# 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 +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) +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) +# 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 +# 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"], +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"] -# ) + ), + 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 #