Skip to content

Commit 4098f99

Browse files
authored
Merge pull request #21 from cleanenergyexchange/dev
docs: fix docs dependency installations
2 parents 6d2e84f + 0cae7d4 commit 4098f99

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- name: 🔧 setup uv
2323
uses: astral-sh/setup-uv@v5
2424
- name: ⚙️ install deps
25-
run: uv sync --extra docs
25+
run: uv sync --group docs
2626
- name: 📙 mkdocs build
2727
run: uv run mkdocs build
2828
- name: 📦 Upload artifacts

docs/features-and-bugfixes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To contribute, follow these steps:
44

55
1. Create **[an issue](https://github.com/cleanenergyexchange/fastapi-zitadel-auth/issues)** explaining what you want to add or fix.
66
2. **Fork** the repository.
7-
3. Install [`uv`](https://docs.astral.sh/uv/) and **install the dependencies** with `uv install --dev`.
7+
3. Install [`uv`](https://docs.astral.sh/uv/) and **install the dependencies** with `uv sync --group dev`.
88
4. Install **pre-commit hooks** with `uv run pre-commit install`.
99
5. Create a **branch** for your feature or fix.
1010
6. Write code.

docs/writing-documentation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ uv sync --group docs
1010

1111
* **Build** the documentation:
1212

13+
```bash
14+
uv run mkdocs build
15+
```
16+
17+
* **Serve** the documentation locally:
18+
1319
```bash
1420
uv run mkdocs serve
1521
```

0 commit comments

Comments
 (0)