docs: build docs using uv

.github/workflows/docs.yml

@@ -20,19 +20,19 @@ on:
 jobs:
   build:
     name: Build
-    uses: equinor/ops-actions/.github/workflows/mkdocs.yml@v9.26.0
+    uses: equinor/ops-actions/.github/workflows/mkdocs.yml@v9.31.0
     with:
-      requirements: docs/requirements.txt
+      requirements: .[docs]
       upload_artifact: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-      git_fetch_depth: 0 # Required by mkdocs-git-revision-date-localized-plugin (listed in requirements file)
+      git_fetch_depth: 0 # Required by MkDocs plugin "mkdocs-git-revision-date-localized-plugin"
     permissions:
       contents: read
 
   deploy:
     name: Deploy
     needs: build
     if: needs.build.outputs.artifact_uploaded == 'true'
-    uses: equinor/ops-actions/.github/workflows/github-pages.yml@v9.26.0
+    uses: equinor/ops-actions/.github/workflows/github-pages.yml@v9.31.0
     with:
       artifact_name: ${{ needs.build.outputs.artifact_name }}
     permissions:

CONTRIBUTING.md

@@ -56,35 +56,8 @@ Once the project files have been created and the trusted publisher has been regi
 
 We use [MkDocs](https://www.mkdocs.org/) with the [Material theme](https://squidfunk.github.io/mkdocs-material/) for documentation. Changes are automatically deployed to <https://equinor.github.io/dataorc/> when merged to main.
 
-### Quick Start
-
-1. **Setup**:
-
-   ```console
-   uv venv
-   .\.venv\Scripts\Activate.ps1  # Windows
-   uv pip install -r docs/requirements.txt
-   ```
-
-2. **Preview locally**:
-
-   ```console
-   python -m mkdocs serve
-   ```
-
-   Documentation available at <http://127.0.0.1:8000/dataorc/>
-
-3. **Test before PR**:
-
-   ```console
-   python -m mkdocs build --strict
-   ```
-
 ### Adding Content
 
 - Edit `.md` files in `docs/` directory
 - Add new pages to `nav` section in `mkdocs.yml`
 - Use standard Markdown syntax
-
-**Note**: Always use `python -m mkdocs` (not just `mkdocs`) to avoid path issues.
-

README.md

@@ -18,6 +18,16 @@ Sync the development environment:
 uv sync --all-extras
 ```
 
+### Building documentation
+
+Build the documentation and run a local development server:
+
+```console
+uv run mkdocs serve --strict
+```
+
+The documentation will be served locally at <http://127.0.0.1:8000/dataorc/>.
+
 ## Contributing
 
 See [contributing guidelines](CONTRIBUTING.md).

pyproject.toml

@@ -10,6 +10,15 @@ license-files = ["LICENSE"]
 
 dependencies = ["dataorc-utils==0.1.0"]
 
+[project.optional-dependencies]
+docs = [
+  "mkdocs>=1.6.1",
+  "mkdocs-material>=9.6.21",
+  "mkdocstrings>=0.30.1",
+  "mkdocstrings-python>=1.12.1",
+  "mkdocs-git-revision-date-localized-plugin>=1.4.7",
+]
+
 [tool.uv.workspace]
 members = ["packages/*"]