Skip to content

Commit de3e9da

Browse files
authored
Merge pull request #1145 from quarto-dev/advanced-docs
Advanced Docs Landing Page
2 parents 59f5bfa + ceed077 commit de3e9da

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

docs/advanced/environment-vars.qmd

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "Environment Variables"
3+
summary: Environment variables Quarto inspects and sets
4+
format: html
5+
draft: true
6+
---
7+
8+
## Variables Quarto inspects
9+
10+
These are variables that you can set to control how Quarto renders documents. For example, you can set them explicitly before running `quarto render`:
11+
12+
``` {.bash filename="Terminal"}
13+
export QUARTO_R=/opt/R/4.2.3/bin
14+
quarto render
15+
```
16+
17+
You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd).
18+
19+
| Variable | Description |
20+
|-----------------|-------------|
21+
| `QUARTO_R` | |
22+
| `QUARTO_PYTHON` | |
23+
| | |
24+
25+
## Variables Quarto sets
26+
27+
These variables are set by Quarto you can query them. For example, you can query them in an executable code cell:
28+
29+
::: panel-tabset
30+
## R
31+
32+
``` r
33+
Sys.getenv("QUARTO_DOCUMENT_PATH")
34+
```
35+
36+
## Python
37+
38+
``` python
39+
import os
40+
print(os.environ["QUARTO_DOCUMENT_PATH"])
41+
```
42+
43+
## Julia
44+
45+
``` julia
46+
ENV["QUARTO_DOCUMENT_PATH"]
47+
```
48+
:::
49+
50+
| Variable | Description |
51+
|----------------|--------------------------------------------------------|
52+
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode |
53+
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered |
54+
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` |
55+
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata |

docs/advanced/index.qmd

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Advanced User Documentation"
3+
format: html
4+
search: false
5+
listing:
6+
type: table
7+
fields: [title, summary]
8+
field-display-names:
9+
summary: Summary
10+
---
11+
12+
Topics on this page may be of interest to advanced users of Quarto.

docs/advanced/jupyter/kernel-execution.qmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Jupyter Kernel Execution
33
format: html
4+
summary: How to support Quarto from a Jupyter kernel
45
---
56

67
Quarto executes Jupyter notebooks using [`nbclient`](https://github.com/jupyter/nbclient) together with a few additional options

0 commit comments

Comments
 (0)