From 85757d43443536c89d8dd29491cdd9979ded6e86 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Sat, 21 Apr 2018 16:13:05 +0200 Subject: [PATCH] clarify in the docs that execute=true cd to outputdir --- docs/src/outputformats.md | 6 ++++-- src/Literate.jl | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/src/outputformats.md b/docs/src/outputformats.md index 81d350a..6b04aff 100644 --- a/docs/src/outputformats.md +++ b/docs/src/outputformats.md @@ -79,8 +79,10 @@ Out[3]: │ 11/15 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 -is also executed and output cells populated. Some of the output rendering -can be controlled with keyword arguments to [`Literate.notebook`](@ref): +is also executed and output cells populated. The current working directory +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 Literate.notebook diff --git a/src/Literate.jl b/src/Literate.jl index 932d2cf..10085db 100644 --- a/src/Literate.jl +++ b/src/Literate.jl @@ -350,7 +350,8 @@ Keyword arguments: see the [Custom pre- and post-processing](@ref Custom-pre-and-post-processing) section of the manual. Defaults to `identity`. - `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 to filter out during notebook generation. Defaults to `true`. See the the manual section on [Interaction with Documenter](@ref Interaction-with-Documenter).