Documentation setup

1. Clone the repo:

git clone https://github.com/dstackai/dstack
cd dstack

curl -LsSf https://astral.sh/uv/install.sh | sh

Warning

Building documentation requires python_version >= 3.11.

uv sync --all-extras

dstack will be installed into the project's .venv in editable mode.

Code formatting and linting can be done automatically on each commit with pre-commit hooks:

uv run pre-commit install

To preview the documentation, run the follow command:

uv run mkdocs serve -w examples -s

If you want to build static files, you can use the following command:

uv run mkdocs build -s