document env vars (#5030)

* document env vars * drop DVC_EXP_AUTO_PUSH from env vars
iterative · Dec 12, 2023 · ad38948 · ad38948
1 parent 1395a08
commit ad38948
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 3 deletions.
diff --git a/content/docs/dvclive/env.md b/content/docs/dvclive/env.md
@@ -1,4 +1,4 @@
-# dvclive.env
+# Environment Variables
 
 List of environment variables to configure DVCLive behavior.
 
@@ -13,5 +13,7 @@ os.environ[env.DVCLIVE_OPEN] = "True"
 - `DVCLIVE_LOGLEVEL`: Configure the
   [logging level](https://docs.python.org/3/library/logging.html#logging-levels)
   of DVCLive. Defaults to `WARNING`.
-- `DVCLIVE_OPEN`: If True, DVCLive will try to automatically open the HTML
-  generated by `Live.make_report()` in the default browser. Defaults to `False`.
+- `DVCLIVE_OPEN`: If `true`, DVCLive will try to automatically open the HTML
+  generated by `Live.make_report()` in the default browser. Defaults to `false`.
+
+See also [DVC environment variables](/doc/user-guide/env).
diff --git a/content/docs/sidebar.json b/content/docs/sidebar.json
@@ -243,6 +243,10 @@
           }
         ]
       },
+      {
+        "label": "Environment Variables",
+        "slug": "env"
+      },
       "troubleshooting",
       {
         "label": "Anonymized Usage Analytics",

diff --git a/content/docs/user-guide/env.md b/content/docs/user-guide/env.md
@@ -0,0 +1,19 @@
+# Environment Variables
+
+List of environment variables to configure DVC behavior.
+
+- `DVC_NO_ANALYTICS`: If `true`, disables
+  [analytics](/doc/user-guide/analytics). Overrides `dvc config core.analytics`.
+- `DVC_PAGER`: Set what program DVC uses for paging output (for example,
+  `more`).
+- `DVC_STUDIO_OFFLINE`: If `true`, disables sharing
+  [live experiments](/doc/studio/user-guide/experiments/live-metrics-and-plots)
+  even if the DVC Studio token is set. Overrides `dvc config studio.offline`.
+- `DVC_STUDIO_REPO_URL`: Set URL of Git remote associated with the DVC Studio
+  project. Overrides `dvc config studio.repo_url`.
+- `DVC_STUDIO_TOKEN`: Set DVC Studio access token to use. Overrides
+  `dvc config studio.token`.
+- `DVC_STUDIO_URL`: Set URL of Studio to use (in case of self-hosted DVC Studio
+  instance). Overrides `dvc config studio.url`.
+
+See also [DVCLive environment variables](/doc/dvclive/env).