docs: set up pipeline (#35)

.github/workflows/docs.yaml

@@ -0,0 +1,47 @@
+name: Build and deploy docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Set cache id
+        run: |
+          echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools
+          pip install mkdocs-material
+
+      - name: Build and deploy docs
+        run: |
+          mkdocs gh-deploy -f dev/mkdocs.yaml --force

README.md

@@ -2,5 +2,6 @@
 
 [![CI](https://img.shields.io/github/actions/workflow/status/mrsmrynk/aviary/ci.yaml?branch=main&color=black&label=CI&logo=GitHub)](https://github.com/mrsmrynk/aviary/actions/workflows/ci.yaml)
 [![Coverage](https://img.shields.io/codecov/c/github/mrsmrynk/aviary/main?color=black&label=Coverage&logo=codecov&logoColor=white)](https://app.codecov.io/gh/mrsmrynk/aviary)
+[![Docs](https://img.shields.io/github/actions/workflow/status/mrsmrynk/aviary/docs.yaml?branch=main&color=black&label=Docs&logo=materialformkdocs&logoColor=white)](https://mrsmrynk.github.io/aviary)
 
 </div>

dev/mkdocs.yaml

@@ -0,0 +1,14 @@
+site_name: aviary
+docs_dir: ../docs
+theme:
+  name: material
+  language: en
+  features:
+    - navigation.instant
+extra:
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/geospaitial-lab
+copyright:
+  © 2024 geospaitial lab

dev/requirements.txt

@@ -1,5 +1,6 @@
 -r ../requirements.txt
 
+mkdocs-material==9.5.20
 pip-audit==2.7.2
 pre-commit==3.7.0
 pytest==8.2.0

docs/index.md

@@ -0,0 +1,3 @@
+# Lorem Ipsum
+
+Lorem Ipsum