Skip to content

Commit 4a82672

Browse files
authored
Merge pull request #1078 from jkrumbiegel/patch-1
Docs for PR 9373
2 parents 7404357 + 355f79f commit 4a82672

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/computations/julia.qmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,12 @@ To enable the cache for a document, add the `cache` option. For example:
210210

211211
The `julia` engine uses the [QuartoNotebookRunner.jl](https://github.com/PumasAI/QuartoNotebookRunner.jl/) package to render notebooks. When you first attempt to render a notebook with the `julia` engine, Quarto will automatically install this package into a private environment that is owned by Quarto. This installation will therefore not interact or conflict with any other Julia environments on your machine. Quarto will use the `julia` binary on your PATH by default, but you can override this using the `QUARTO_JULIA` environment variable.
212212

213+
#### Using custom versions of `QuartoNotebookRunner`
214+
215+
In special circumstances, you may not want to use the specific `QuartoNotebookRunner` version that Quarto installs for you. For example, you might be developing `QuartoNotebookRunner` itself, or you need to use a fork or an unreleased version with a bugfix. In this case, set the [environment variable](/docs/projects/environment.qmd) `QUARTO_JULIA_PROJECT` to a directory of a julia environment that has `QuartoNotebookRunner` installed.
216+
217+
As an example, you could install the main branch of `QuartoNotebookRunner` into the directory `/some/dir` by executing `]activate /some/dir` in a julia REPL followed by `]add QuartoNotebookRunner#main`. As long as there is no server currently running, running a command like `QUARTO_JULIA_PROJECT=/some/dir quarto render some_notebook.qmd` in your terminal will ensure the server process is started using the custom `QuartoNotebookRunner`. You can also set `quarto`'s `--execute-debug` flag and check the output to verify that the custom environment is being used.
218+
213219
### Rendering notebooks
214220

215221
To use the `julia` engine, you have to specify it in your frontmatter:

0 commit comments

Comments
 (0)