use uvx

Author: vincentsarago

.github/workflows/cicd.yaml

@@ -58,8 +58,9 @@ jobs:
       - name: Set up Python3
         run: uv python install 3
 
-      - name: Test generating docs
-        run: make docs
+      - name: Test docs
+        run: |
+          uvx --with-requirements requirements/requirements-docs.txt mkdocs build --strict -f docs/mkdocs.yml 
 
   benchmark:
     needs: [test]

.github/workflows/deploy_mkdocs.yml

@@ -29,13 +29,5 @@ jobs:
       - name: Set up Python3
         run: uv python install 3
 
-      - name: Install dependencies
-        run: |
-          uv sync --all-extras
-
-      - name: Install dependencies
-        run: |
-          uv run pip install -r requirements/requirements-docs.txt
-
       - name: Deploy docs
-        run: uv run mkdocs gh-deploy --force -f docs/mkdocs.yml
+        run: uvx --with-requirements requirements/requirements-docs.txt mkdocs gh-deploy --force -f docs/mkdocs.yml

CONTRIBUTING.md

@@ -26,19 +26,20 @@ uv run pre-commit run --all-files
 ```bash
 git clone https://github.com/stac-utils/stac-fastapi.git
 cd stac-fastapi
-uv pip instal -r requirements/requirements-docs.txt
+# Build docs
+uvx --with-requirements requirements/requirements-docs.txt mkdocs build -f docs/mkdocs.yml
 ```
 
 Hot-reloading docs:
 
 ```bash
-uv run mkdocs serve -f docs/mkdocs.yml
+uvx --with-requirements requirements/requirements-docs.txt mkdocs serve -f docs/mkdocs.yml --livereload
 ```
 
 To manually deploy docs (note you should never need to do this because GitHub
 Actions deploys automatically for new commits.):
 
 ```bash
 # deploy
-uv run mkdocs gh-deploy -f docs/mkdocs.yml
+uvx --with-requirements requirements/requirements-docs.txt mkdocs gh-deploy -f docs/mkdocs.yml
 ```

Makefile

@@ -11,9 +11,8 @@ test: install
 	uv run pytest
 
 .PHONY: docs
-docs: install
-	uv run pip install -r requirements/requirements-docs.txt && \
-	uv run mkdocs build -f docs/mkdocs.yml
+docs:
+	uvx --with-requirements requirements/requirements-docs.txt mkdocs build -f docs/mkdocs.yml
 
 .PHONY: benchmark
 benchmark: install

requirements/requirements-docs.txt

@@ -3,4 +3,8 @@ mkdocs>=1.4.3
 mkdocs-jupyter>=0.24.5
 mkdocs-material[imaging]>=9.5
 griffe-inherited-docstrings>=1.0.0
-mkdocstrings[python]>=0.25.1
+mkdocstrings[python]>=0.25.1
+
+-e stac_fastapi/types
+-e stac_fastapi/api
+-e stac_fastapi/extensions