Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeldycke committed Jul 3, 2024
1 parent ddc8d0e commit f7ce849
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ $ git checkout main
Install package in editable mode with all development dependencies:

```shell-session
$ python3 -m pip install poetry
$ poetry install
$ python -m pip install uv
$ uv venv
$ source .venv/bin/activate
$ uv pip install --all-extras .
```

Now you’re ready to hack and abuse git!
Expand All @@ -61,17 +63,17 @@ Now you’re ready to hack and abuse git!
After the steps above, you are free to play with the bleeding edge version of `mdedup`:

```shell-session
$ poetry run mdedup --version
mdedup, version 7.0.0-dev
$ uv run mdedup --version
(...)
mdedup, version 7.3.1
```

## Unit-tests

Run unit-tests with:

```shell-session
$ poetry run pytest
$ uv run pytest
```

## Coding style
Expand All @@ -84,7 +86,7 @@ The documentation you’re currently reading can be built locally with
[Sphinx](https://www.sphinx-doc.org):

```shell-session
$ poetry run sphinx-build -b html ./docs ./docs/html
$ uv run sphinx-build -b html ./docs ./docs/html
```

The generation of API documentation is
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f7ce849

Please sign in to comment.