diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/README.md b/docs/README.md index cbef50e..9fe165a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,11 +3,10 @@ This directory contains the mkdocs configuration and markdown files for the PyDis DevOps documentation. -To work on these files, install the docs dependencies with `poetry install ---with docs` in the root folder. +To work on these files, install the docs dependencies with `uv sync` in the root folder. You can work locally on the site by navigating to the root directory and running -`poetry run task serve-docs` which will start a local server with live -reloading. You can also run `poetry run task build-docs` in the root to build a +`uv run task serve-docs` which will start a local server with live +reloading. You can also run `uv run task build-docs` in the root to build a local copy of the documentation, which will be placed in the `docs/site` folder (`site` folder of this directory). |