Skip to content

Commit

Permalink
Minor documentation and uv sync fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
egparedes committed Jan 30, 2025
1 parent a6a986b commit 9f10bc6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Follow the installation instructions below to initialize a development virtual e

### Development Environment Installation using `uv`

GT4Py uses the [`uv`](https://docs.astral.sh/uv/) project manager for the development workflow. `uv` is a versatile tool that consolidates functionality usually distributed across different applications into subcommands.
GT4Py uses the [`uv`](https://docs.astral.sh/uv/) project manager (`uv>=0.5.25`) for the development workflow. `uv` is a versatile tool that consolidates functionality usually distributed across different applications into subcommands.

- The `uv pip` subcommand provides a _fast_ Python package manager, emulating [`pip`](https://pip.pypa.io/en/stable/).
- The `uv export | lock | sync` subcommands manage dependency versions in a manner similar to the [`pip-tools`](https://pip-tools.readthedocs.io/en/stable/) command suite.
Expand Down Expand Up @@ -111,7 +111,7 @@ Recurrent development tasks like bumping versions of used development tools or r
GT4Py uses the Sphinx tool for the documentation. To build browseable HTML documentation, install the required tools provided in the `docs` dependency group:

```bash
uv install --group docs --extra all # or --group dev
uv sync --group docs --extra all # or --group dev
```

(Note that most likely these tools are already installed in your development environment, since the `docs` group is included in the `dev` group, which installed by default by `uv sync` if no dependency groups are specified.)
Expand Down
2 changes: 1 addition & 1 deletion dev-tasks.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#! /usr/bin/env -S uv run -q
#! /usr/bin/env -S uv run -q --script
#
# GT4Py - GridTools Framework
#
Expand Down

0 comments on commit 9f10bc6

Please sign in to comment.