From 6601925ba6d8093425defd23959bceda27d6a17e Mon Sep 17 00:00:00 2001 From: David de la Iglesia Castro Date: Thu, 16 Dec 2021 10:57:27 +0100 Subject: [PATCH 1/5] ref: Add `plots.auto_open` in `dvc.config` --- content/docs/command-reference/config.md | 4 ++++ content/docs/command-reference/plots/diff.md | 4 +++- content/docs/command-reference/plots/show.md | 4 +++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 58ed471374..793544926a 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -281,6 +281,10 @@ be overidden explicitly through CLI arguments or through responses in prompts [custom HTML template](/doc/command-reference/plots#html-templates) for `dvc plots`. Accepts a path relative to the `.dvc/` folder. +- `plots.auto_open` - if enabled, DVC will automatically open a browser with the + `html` generated by `dvc plots` commands. Accepts values `true` and `false` + (default). + ## Example: Add an S3 remote, and set it as default > 💡 Before adding an S3 remote, be sure to diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index ad80b7b4e3..37f5fb7f85 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -90,7 +90,9 @@ all the current plots, without comparisons. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - opens the generated plot in the browser automatically. +- `--open` - opens the generated plot in the browser automatically. You can + enable the [plots.auto_open](/doc/command-reference/config#plots) option in + `dvc config`. - `--no-header` - lets DVC know that CSV or TSV `--targets` do not have a header. A 0-based numeric index can be used to identify each column instead of diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index dab9226672..a436339e64 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -64,7 +64,9 @@ please see `dvc plots`. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - opens the generated plot in the browser automatically. +- `--open` - opens the generated plot in the browser automatically. You can + enable the [plots.auto_open](/doc/command-reference/config#plots) option in + `dvc config`. - `--no-header` - lets DVC know that CSV or TSV `targets` do not have a header. A 0-based numeric index can be used to identify each column instead of names. From aecaf8b17c7bca1f4db2e8159fba4c30ad072fa4 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 17 Dec 2021 02:05:13 -0600 Subject: [PATCH 2/5] ref: copy edits around plots --open --- content/docs/command-reference/config.md | 5 ++--- content/docs/command-reference/plots/diff.md | 5 ++--- content/docs/command-reference/plots/show.md | 5 ++--- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 793544926a..83e2e3fe07 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -281,9 +281,8 @@ be overidden explicitly through CLI arguments or through responses in prompts [custom HTML template](/doc/command-reference/plots#html-templates) for `dvc plots`. Accepts a path relative to the `.dvc/` folder. -- `plots.auto_open` - if enabled, DVC will automatically open a browser with the - `html` generated by `dvc plots` commands. Accepts values `true` and `false` - (default). +- `plots.auto_open` - if `true`, DVC will automatically open the HTML + generated by `dvc plots` commands in a browser. `false` by default ## Example: Add an S3 remote, and set it as default diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index 37f5fb7f85..5c1f7ee848 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -90,9 +90,8 @@ all the current plots, without comparisons. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - opens the generated plot in the browser automatically. You can - enable the [plots.auto_open](/doc/command-reference/config#plots) option in - `dvc config`. +- `--open` - open the HTML generated in a browser automatically. You can + enable `dvc config plots.auto_open` to make this the default behavior. - `--no-header` - lets DVC know that CSV or TSV `--targets` do not have a header. A 0-based numeric index can be used to identify each column instead of diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index a436339e64..362736bff2 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -64,9 +64,8 @@ please see `dvc plots`. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - opens the generated plot in the browser automatically. You can - enable the [plots.auto_open](/doc/command-reference/config#plots) option in - `dvc config`. +- `--open` - open the HTML generated in a browser automatically. You can + enable `dvc config plots.auto_open` to make this the default behavior. - `--no-header` - lets DVC know that CSV or TSV `targets` do not have a header. A 0-based numeric index can be used to identify each column instead of names. From 143a8df382a169f9bbb3f71003ebd7e5083a0141 Mon Sep 17 00:00:00 2001 From: "restyled-io[bot]" <32688539+restyled-io[bot]@users.noreply.github.com> Date: Fri, 17 Dec 2021 02:10:07 -0600 Subject: [PATCH 3/5] Restyled by prettier (#3109) Co-authored-by: Restyled.io --- content/docs/command-reference/config.md | 4 ++-- content/docs/command-reference/plots/diff.md | 4 ++-- content/docs/command-reference/plots/show.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 83e2e3fe07..da328da136 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -281,8 +281,8 @@ be overidden explicitly through CLI arguments or through responses in prompts [custom HTML template](/doc/command-reference/plots#html-templates) for `dvc plots`. Accepts a path relative to the `.dvc/` folder. -- `plots.auto_open` - if `true`, DVC will automatically open the HTML - generated by `dvc plots` commands in a browser. `false` by default +- `plots.auto_open` - if `true`, DVC will automatically open the HTML generated + by `dvc plots` commands in a browser. `false` by default ## Example: Add an S3 remote, and set it as default diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index 5c1f7ee848..f2a96f027c 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -90,8 +90,8 @@ all the current plots, without comparisons. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - open the HTML generated in a browser automatically. You can - enable `dvc config plots.auto_open` to make this the default behavior. +- `--open` - open the HTML generated in a browser automatically. You can enable + `dvc config plots.auto_open` to make this the default behavior. - `--no-header` - lets DVC know that CSV or TSV `--targets` do not have a header. A 0-based numeric index can be used to identify each column instead of diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index 362736bff2..2e4eec7231 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -64,8 +64,8 @@ please see `dvc plots`. - `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of HTML. See `dvc plots` for more info. -- `--open` - open the HTML generated in a browser automatically. You can - enable `dvc config plots.auto_open` to make this the default behavior. +- `--open` - open the HTML generated in a browser automatically. You can enable + `dvc config plots.auto_open` to make this the default behavior. - `--no-header` - lets DVC know that CSV or TSV `targets` do not have a header. A 0-based numeric index can be used to identify each column instead of names. From 91c251b0ffac19451c0202a78c030dad39ae9fdd Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 17 Dec 2021 02:11:08 -0600 Subject: [PATCH 4/5] Update content/docs/command-reference/config.md --- content/docs/command-reference/config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index da328da136..65a9eb3450 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -281,8 +281,8 @@ be overidden explicitly through CLI arguments or through responses in prompts [custom HTML template](/doc/command-reference/plots#html-templates) for `dvc plots`. Accepts a path relative to the `.dvc/` folder. -- `plots.auto_open` - if `true`, DVC will automatically open the HTML generated - by `dvc plots` commands in a browser. `false` by default +- `plots.auto_open` - if `true`, DVC will automatically open the HTML file + generated by `dvc plots` commands in a browser. `false` by default ## Example: Add an S3 remote, and set it as default From 736a9a176663d2569c2e74dbc470dc7880cf8790 Mon Sep 17 00:00:00 2001 From: David de la Iglesia Castro Date: Thu, 13 Jan 2022 17:03:44 +0100 Subject: [PATCH 5/5] Mention auto_open in pcp --- content/docs/command-reference/exp/show.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/command-reference/exp/show.md b/content/docs/command-reference/exp/show.md index b0c278842e..64d2b24ef4 100644 --- a/content/docs/command-reference/exp/show.md +++ b/content/docs/command-reference/exp/show.md @@ -128,7 +128,8 @@ will be generated using the same data from the table. destination `folder` of the plot. By default its `dvc_plots`. - `--open` - when used with `--pcp`, opens the generated plot in a browser - automatically. + automatically. You can enable `dvc config plots.auto_open` to make this the + default behavior. ## Examples