Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Nov 30, 2023
1 parent 8667a36 commit bae1643
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Default: None | Type: Callable

### `autoreload`

Whether to autoreload server when script changes.
Whether to autoreload the page whenever the script or one of its dependencies changes.

Default: False | Type: Boolean

Expand Down
4 changes: 4 additions & 0 deletions doc/getting_started/core_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Once you run that command Panel will launch a server that will serve your app, o

<img src="https://assets.holoviz.org/panel/gifs/vscode_autoreload.gif" style="margin-left: auto; margin-right: auto; display: block;"></img>

```{note}
We recommend installing `watchfiles`, which will provide a significantly better user experience when using `--autoreload`.
```

> Checkout [How-to > Prepare to develop](../how_to/prepare_to_develop.md) for more guidance on each of the development environment options.
## Control flow

Expand Down
5 changes: 4 additions & 1 deletion doc/how_to/server/commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@ or even serve a number of apps at once:

For development it can be particularly helpful to use the ``--autoreload`` option to `panel serve` as that will automatically reload the page whenever the application code or any of its imports change.

The ``panel serve`` command has the following options:
```{note}
We recommend installing `watchfiles`, which will provide a significantly better user experience when using `--autoreload`.
```

The ``panel serve`` command has the following options:

``` console
positional arguments:
Expand Down

0 comments on commit bae1643

Please sign in to comment.