Browse Source

clarify in the docs that execute=true cd to outputdir

pull/5/head
Fredrik Ekre 8 years ago
parent
commit
85757d4344
  1. 6
      docs/src/outputformats.md
  2. 3
      src/Literate.jl

6
docs/src/outputformats.md

@ -79,8 +79,10 @@ Out[3]: │ 11/15
We note that lines starting with `#'` is put in markdown cells, We note that lines starting with `#'` is put in markdown cells,
and the code lines have been put in code cells. By default the notebook and the code lines have been put in code cells. By default the notebook
is also executed and output cells populated. Some of the output rendering is also executed and output cells populated. The current working directory
can be controlled with keyword arguments to [`Literate.notebook`](@ref): is set to the specified output directory the notebook is executed.
Some of the output rendering can be controlled with keyword
arguments to [`Literate.notebook`](@ref):
```@docs ```@docs
Literate.notebook Literate.notebook

3
src/Literate.jl

@ -350,7 +350,8 @@ Keyword arguments:
see the [Custom pre- and post-processing](@ref Custom-pre-and-post-processing) see the [Custom pre- and post-processing](@ref Custom-pre-and-post-processing)
section of the manual. Defaults to `identity`. section of the manual. Defaults to `identity`.
- `execute`: a boolean deciding if the generated notebook should also - `execute`: a boolean deciding if the generated notebook should also
be executed or not. Defaults to `true`. be executed or not. Defaults to `true`. The current working directory
is set to `outputdir` when executing the notebook.
- `documenter`: boolean that says if the source contains Documenter.jl specific things - `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 to filter out during notebook generation. Defaults to `true`. See the the manual
section on [Interaction with Documenter](@ref Interaction-with-Documenter). section on [Interaction with Documenter](@ref Interaction-with-Documenter).

Loading…
Cancel
Save