Skip to content

ref: Add plots.auto_open in dvc.config #3101

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
daavoo merged 6 commits into from
Jan 13, 2022
Merged

ref: Add plots.auto_open in dvc.config #3101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6601925
ref: Add `plots.auto_open` in `dvc.config`
daavoo Dec 16, 2021
aecaf8b
ref: copy edits around plots --open
jorgeorpinel Dec 17, 2021
143a8df
Restyled by prettier (#3109)
restyled-io[bot] Dec 17, 2021
91c251b
Update content/docs/command-reference/config.md
jorgeorpinel Dec 17, 2021
687559a
Merge branch 'master' into plots-auto-open
daavoo Jan 13, 2022
736a9a1
Mention auto_open in pcp
daavoo Jan 13, 2022
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
9 changes: 9 additions & 0 deletions content/docs/command-reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,15 @@ experiments or projects use a similar structure.
files will be stored, by default in `.dvc/tmp/index`. This may be necessary
when using DVC on NFS or other mounted volumes.

### plots

- `plots.html_template` - sets a
[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 file
generated by `dvc plots` commands in a browser. `false` by default

## Example: Add an S3 remote, and set it as default

> 💡 Before adding an S3 remote, be sure to
Expand Down
3 changes: 2 additions & 1 deletion content/docs/command-reference/exp/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion content/docs/command-reference/plots/diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,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.
- `--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
Expand Down
3 changes: 2 additions & 1 deletion content/docs/command-reference/plots/show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,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.
- `--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.
Expand Down