From 20cf93c3c8c2e151873d9e9c01ee056a3388496d Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Tue, 21 Aug 2018 10:43:28 +0200 Subject: [PATCH] Document the credit option, fix #22. --- src/Literate.jl | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/Literate.jl b/src/Literate.jl index 733bbc0..f8e0063 100644 --- a/src/Literate.jl +++ b/src/Literate.jl @@ -224,6 +224,9 @@ Keyword arguments: section on [Interaction with Documenter](@ref Interaction-with-Documenter). - `keep_comments`: boolean that, if set to `true`, keeps markdown lines as comments in the output script. Defaults to `false`. +- `credit`: boolean that controls the addition of `This file was generated with + Literate.jl ...` to the bottom of the page. If you find Literate.jl useful then + feel free to keep this to the default, which is `true`. """ function script(inputfile, outputdir; preprocess = identity, postprocess = identity, name = filename(inputfile), documenter = true, credit = true, @@ -299,6 +302,9 @@ Keyword arguments: "```julia" => "```" ```` if `documenter = false`. +- `credit`: boolean that controls the addition of `This file was generated with + Literate.jl ...` to the bottom of the page. If you find Literate.jl useful then + feel free to keep this to the default, which is `true`. """ function markdown(inputfile, outputdir; preprocess = identity, postprocess = identity, name = filename(inputfile), documenter::Bool = true, credit = true, @@ -401,6 +407,9 @@ Keyword arguments: - `documenter`: boolean that says if the source contains Documenter.jl specific things to filter out during notebook generation. Defaults to `true`. See the the manual section on [Interaction with Documenter](@ref Interaction-with-Documenter). +- `credit`: boolean that controls the addition of `This file was generated with + Literate.jl ...` to the bottom of the page. If you find Literate.jl useful then + feel free to keep this to the default, which is `true`. """ function notebook(inputfile, outputdir; preprocess = identity, postprocess = identity, execute::Bool=true, documenter::Bool=true, credit = true,