Skip to content

Improve discoverability of environment variables documentation #1906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwickham merged 3 commits into from
Feb 26, 2026
Merged

Improve discoverability of environment variables documentation #1906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dfbe229
Clarify page titles
cwickham Feb 24, 2026
cebfb56
Add link project env vars -> quarto env vars
cwickham Feb 24, 2026
bb81466
Use a callout to link to project environment vars
cwickham Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _quarto.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,8 @@ website:
- docs/projects/quarto-projects.qmd
- docs/projects/code-execution.qmd
- docs/projects/profiles.qmd
- docs/projects/environment.qmd
- text: "Environment Variables"
href: docs/projects/environment.qmd
- docs/projects/scripts.qmd
- docs/projects/virtual-environments.qmd
- docs/projects/binder.qmd
Expand Down
8 changes: 6 additions & 2 deletions docs/advanced/environment-vars.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Environment Variables"
title: "Quarto Environment Variables"
summary: Environment variables Quarto inspects and sets
format: html
---
Expand All @@ -13,7 +13,11 @@ export QUARTO_R=/opt/R/4.2.3/bin
quarto render
```

You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd).
::: callout-tip
## Working on a Quarto Project?

See [Project Environment Variables](/docs/projects/environment.qmd) for ways to set environment variables in Quarto Projects, including profile-specific environments and managing secrets.
:::

+---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | |
Expand Down
8 changes: 7 additions & 1 deletion docs/projects/environment.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Environment Variables"
title: "Project Environment Variables"
---

## Overview
Expand All @@ -13,6 +13,12 @@ You may have one or more environment variables that you want to make sure are se
5. Provide options for language interpreters (e.g. `PYTHONINSPECT` or `TZDIR`).
6. Determine which versions of Python and R are used (e.g. `QUARTO_PYTHON`, `QUARTO_R`, `PY_PYTHON`, or `RETICULATE_PYTHON`).

::: callout-tip
## Looking for a specific Quarto environment variable?

See [Quarto Environment Variables](/docs/advanced/environment-vars.qmd) for a list of environment variables that Quarto reads and sets.
:::

Quarto projects can define a set of standard environment variables as well as vary which environment variables are defined based on the [active project profile](profiles.qmd). It's also possible to use environment variables that are defined only on the local system and not checked in to version control.

## Environment File
Expand Down