From d8595e266fc688c492ec7a2596a84c86587a85bd Mon Sep 17 00:00:00 2001 From: Shuhei Kadowaki Date: Fri, 6 Mar 2020 10:14:21 +0900 Subject: [PATCH] more doc fixes --- doc/src/usage.md | 2 +- src/Weave.jl | 2 +- src/config.jl | 9 ++++----- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/src/usage.md b/doc/src/usage.md index d8176f6..55c2ee1 100644 --- a/doc/src/usage.md +++ b/doc/src/usage.md @@ -199,5 +199,5 @@ You can call `include_weave` on a Weave document to run the contents of all code chunks in Julia. ```@docs -include_weave(doc, informat=:auto) +include_weave ``` diff --git a/src/Weave.jl b/src/Weave.jl index 204027d..d2d68e4 100644 --- a/src/Weave.jl +++ b/src/Weave.jl @@ -175,7 +175,7 @@ function weave(doc::AbstractString, doctype::AbstractString) end """ - notebook(source::String; out_path=:pwd, timeout=-1, nbconvert_options="", jupyter_path = "jupyter") + notebook(source::String; out_path=:pwd, timeout=-1, nbconvert_options="", jupyter_path = "jupyter") Convert Weave document `source` to Jupyter notebook and execute the code using nbconvert. **Ignores** all chunk options diff --git a/src/config.jl b/src/config.jl index 7bc112c..b02644a 100644 --- a/src/config.jl +++ b/src/config.jl @@ -41,14 +41,13 @@ const defaultParams = const rcParams = deepcopy(defaultParams) """ -`set_chunk_defaults(opts::Dict{Symbol, Any})` + set_chunk_defaults(opts::Dict{Symbol, Any}) -Set default options for code chunks, use get_chunk_defaults -to see the current values. +Set default options for code chunks, use [`get_chunk_defaults`](@ref) to see the current values. -e.g. set default dpi to 200 and fig_width to 8 +E.g.: set default `dpi` to 200 and `fig_width` to 8 -``` +```julia julia> set_chunk_defaults(Dict{Symbol, Any}(:dpi => 200, fig_width => 8)) ``` """