more doc fixes

pull/147/merge
Shuhei Kadowaki 2020-03-06 10:14:21 +09:00
parent 230a8c5454
commit d8595e266f
3 changed files with 6 additions and 7 deletions

View File

@ -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
```

View File

@ -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

View File

@ -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))
```
"""