Skip to content

Commit

Permalink
move docs to UV (#161)
Browse files Browse the repository at this point in the history
* move docs to UV

* add uv
  • Loading branch information
NiklasRosenstein authored Jan 2, 2025
1 parent fd98bc4 commit 88e136a
Show file tree
Hide file tree
Showing 7 changed files with 838 additions and 43 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ jobs:
if: github.event_name == 'pull_request'
- uses: actions/setup-python@v5
with: { python-version: "3.10" }
- run: python -m pip install pipx -q && pipx install .
- run: slap run --no-venv-check docs:install
- uses: astral-sh/setup-uv@v5
- run: uv tool install .
- run: slap run --no-venv-check docs:build
- uses: actions/upload-artifact@v4
with: { name: docs, path: docs/site }
Expand Down
1 change: 1 addition & 0 deletions docs/.python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.13
45 changes: 45 additions & 0 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[project]
name = "docs"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.10, <4"
dependencies = [
"babel==2.15.0",
"certifi==2024.2.2",
"charset-normalizer==3.3.2",
"click==8.1.7",
"colorama==0.4.6",
"ghp-import==2.1.0",
"griffe==0.45.2",
"idna==3.7",
"jinja2==3.1.4",
"markdown==3.6",
"markupsafe==3.0.2",
"mergedeep==1.3.4",
"mkdocs-autorefs==1.0.1",
"mkdocs==1.6.0",
"mkdocs-material==9.5.25",
"mkdocs-material-extensions==1.3.1",
"mkdocstrings==0.25.1",
"mkdocstrings-python==1.10.3",
"mksync==0.1.4",
"networkx==3.3",
"packaging==24.0",
"paginate==0.5.6",
"pathspec==0.12.1",
"platformdirs==4.2.2",
"pygments==2.18.0",
"pymdown-extensions==10.8.1",
"python-adjudicator==0.3.2",
"python-dateutil==2.9.0.post0",
"pyyaml==6.0.1",
"pyyaml-env-tag==0.1",
"regex==2024.5.15",
"requests==2.32.3",
"six==1.16.0",
"typeapi==1.5.1",
"typing-extensions==4.12.0",
"urllib3==2.2.1",
"watchdog==6.0.0",
]
37 changes: 0 additions & 37 deletions docs/requirements.txt

This file was deleted.

700 changes: 700 additions & 0 deletions docs/uv.lock

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,8 @@ ruff-format = "ruff format --check"
ruff-lint = "ruff check"

[tool.slap.run]
"docs:build" = "slap run --use-venv docs -- bash -xc 'export PATH=\"$(slap venv -p)/bin:${PATH}\" && cd docs && mksync -i docs/changelog.md && mkdocs build'"
"docs:dev" = "slap run --use-venv docs -- bash -xc 'export PATH=\"$(slap venv -p)/bin:${PATH}\" && cd docs && mksync -i docs/changelog.md && mkdocs serve'"
"docs:install" = "slap venv -c docs --python python3.10 && slap run --use-venv docs -- pip install -r docs/requirements.txt"
"docs:build" = "cd docs && uv run -- bash -xc 'mksync -i docs/changelog.md && mkdocs build'"
"docs:dev" = "cd docs && uv run -- bash -xc 'mksync -i docs/changelog.md && mkdocs serve'"
fmt = "ruff format ."

[tool.mypy]
Expand Down
89 changes: 88 additions & 1 deletion uv.lock

Large diffs are not rendered by default.

0 comments on commit 88e136a

Please sign in to comment.