refactor docs

Author: vincentsarago

.github/workflows/cicd.yaml

@@ -46,7 +46,18 @@ jobs:
   test-docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - name: Checkout main
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.9.*" 
+          enable-cache: true
+    
+      - name: Set up Python3
+        run: uv python install 3
+      
       - name: Test generating docs
         run: make docs
 

CONTRIBUTING.md

@@ -16,6 +16,9 @@ This repo is set to use `pre-commit` to run *ruff*, *pydocstring* and mypy when
 
 ```bash
 uv run pre-commit install 
+
+# If needed, you can run pre-commit script manually 
+uv run pre-commit run --all-files 
 ```
 
 ### Docs

Dockerfile

@@ -17,6 +17,6 @@ WORKDIR /app
 COPY . /app
 
 RUN python -m pip install \
-    -e ./stac_fastapi/types[dev] \
-    -e ./stac_fastapi/api[dev] \
-    -e ./stac_fastapi/extensions[dev]
+    -e ./stac_fastapi/types \
+    -e ./stac_fastapi/api \
+    -e ./stac_fastapi/extensions

Dockerfile.docs

@@ -4,21 +4,17 @@ image:
 
 .PHONY: install
 install:
-	python -m pip install wheel && \
-	python -m pip install -e ./stac_fastapi/types[dev] && \
-	python -m pip install -e ./stac_fastapi/api[dev] && \
-	python -m pip install -e ./stac_fastapi/extensions[dev]
+	uv sync --all-extras
 
-.PHONY: docs-image
-docs-image:
-	docker compose -f compose.docs.yml \
-		build
+.PHONY: test
+test: install
+	uv run pytest
 
 .PHONY: docs
-docs: docs-image
-	docker compose -f compose.docs.yml \
-		run docs
+docs: install
+	uv run pip install -r requirements/requirements-docs.txt && \
+	uv run mkdocs build -f docs/mkdocs.yml
 
-.PHONY: test
-test: image
-	python -m pytest .
+.PHONY: benchmark
+benchmark: install
+	uv run pytest stac_fastapi/api/tests/benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median'