👷 Deploy docs.

Author: rafalkrupinski

.config/mise.toml

@@ -8,4 +8,5 @@ check = 'ruff check'
 format = 'ruff format'
 install = 'poetry install --all-groups --all-extras'
 mkdocs = 'poetry run mkdocs build -f .config/mkdocs.yaml'
-mypy = 'mypy --python-executable "$(poetry env info -p)/bin/python" --hide-absolute-path'
+mkdocs-serve = 'poetry run mkdocs serve -f .config/mkdocs.yaml -a 0.0.0.0:8000'
+mypy = 'mypy --python-executable "$(poetry env info -p)/lib/python3.10/site-packages" --hide-absolute-path'

.config/mkdocs.yaml

@@ -1,10 +1,11 @@
-copyright: Copyright © 2022-2025 Rafał Krupiński
+copyright: Copyright © 2022-2026 Rafał Krupiński
 site_name: Lapidary
 repo_url: https://github.com/python-lapidary/lapidary
 repo_name: python-lapidary/lapidary
 site_url: https://lapidary.github.io/lapidary
 site_description: "Declarative Web API client for python"
 site_dir: "../site"
+edit_uri: edit/main/docs/
 watch:
 - mkdocs.yaml
 - ../src
@@ -13,6 +14,7 @@ watch:
 docs_dir: ../docs
 exclude_docs: |
   adr
+  theme
 
 nav:
 - index.md
@@ -21,6 +23,7 @@ nav:
   - usage/operation.md
   - usage/auth.md
 - API reference: reference/api.md
+- Lapidary Render: https://lapidary.dev/lapidary-render
 
 validation:
   omitted_files: warn
@@ -29,27 +32,31 @@ validation:
 
 
 theme:
+  custom_dir: ../docs/theme
   name: material
   logo: assets/logo.svg
   icon:
     logo: assets/logo.svg
+    repo: fontawesome/brands/git-alt
   favicon: assets/logo.svg
+  repo_branch: main
+
   features:
   - announce.dismiss
   - content.action.view
   - content.code.annotate
   - content.code.copy
   - content.tooltips
   - navigation.footer
+  - navigation.instant
   - navigation.instant.preview
   - navigation.path
   - navigation.sections
-  - navigation.tabs
-  - navigation.tabs.sticky
   - navigation.top
   - search.highlight
   - search.suggest
   - toc.follow
+  font: false
   palette:
   - media: "(prefers-color-scheme)"
     toggle:
@@ -105,7 +112,7 @@ plugins:
       python:
         inventories:
         - https://docs.python.org/3/objects.inv
-        paths: [src]
+        paths: [../src]
         options:
           backlinks: tree
           docstring_section_style: spacy
@@ -127,19 +134,10 @@ plugins:
           show_symbol_type_toc: true
           signature_crossrefs: true
           summary: true
-- llmstxt:
-    full_output: llms-full.txt
-    sections:
-      Usage:
-      - index.md
-      API:
-      - reference/api.md
-#- git-revision-date-localized:
-#    enabled: !ENV [DEPLOY, false]
-#    enable_creation_date: true
-#    type: timeago
 - minify:
     minify_html: !ENV [DEPLOY, false]
+- privacy:
+    enabled: true
 
 extra:
   social:
@@ -150,14 +148,5 @@ extra:
   - icon: fontawesome/brands/python
     link: https://pypi.org/project/lapidary/
   analytics:
-    feedback:
-      title: Was this page helpful?
-      ratings:
-        - icon: material/emoticon-happy-outline
-          name: This page was helpful
-          data: 1
-          note: Thanks for your feedback!
-        - icon: material/emoticon-sad-outline
-          name: This page could be improved
-          data: 0
-          note: Let us know how we can improve this page.
+    provider: goatcounter
+    code: lapidary

.devcontainer/Dockerfile

@@ -1,8 +1,8 @@
 FROM ghcr.io/astral-sh/uv:alpine
 
-RUN apk add mise git bash --no-cache
+RUN apk add mise git bash git ssh-client-default --no-cache
 
-RUN uv python install 3.14
+RUN uv python install 3.10
 
 RUN \
     echo 'eval "$(mise activate bash)"' >> ~/.bashrc &&\

.devcontainer/devcontainer.json

@@ -1,13 +1,23 @@
 {
+  "appPort": [
+    8000
+  ],
   "build": {
     "dockerfile": "Dockerfile"
   },
-  "remoteUser": "root",
-  "remoteEnv": {
-    "MISE_TRUSTED_CONFIG_PATHS": "/",
-  },
+  containerUser: "dev",
+  postCreateCommand: "mise -c /workspaces/lapidary install",
   postStartCommand: [
     "poetry install --all-groups --all-extras"
   ],
-  postCreateCommand: "mise -c /workspaces/lapidary install"
+  "remoteEnv": {
+    "MISE_TRUSTED_CONFIG_PATHS": "/"
+  },
+  runArgs: [
+    "--userns=keep-id:uid=1000,gid=1000",
+  // seems @devcontainers/cli doesn't like forwardPorts
+    "-p",
+    "8000:8000"
+  ],
+  updateRemoteUserUID: true
 }

.github/workflows/mkdocs.yaml

@@ -0,0 +1,48 @@
+name: Build and publish docs
+
+on:
+  push:
+    branches:
+    - develop
+    - main
+  workflow_dispatch:
+
+jobs:
+  mkdocs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: '3.x'
+
+    - name: Cache Poetry dependencies
+      uses: actions/cache@v5
+      with:
+        path: |
+          ~/.cache/pypoetry
+          ~/.cache/pip
+        key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-poetry-
+
+    - name: Install dependencies
+      run: |
+        pip install poetry
+        poetry install --no-root
+
+    - name: Build site
+      run: poetry run mkdocs build -f .config/mkdocs.yaml
+
+    - name: Publish to org pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        destination_dir: lapidary-runtime
+        external_repository: python-lapidary/lapidary.dev
+        personal_token: ${{ secrets.GH_PAT }}
+        publish_branch: gh-pages
+        publish_dir: site
+        user_email: 'github-actions[bot]@users.noreply.github.com'
+        user_name: 'github-actions[bot]'

.github/workflows/test_publish.yaml

@@ -1,7 +1,9 @@
 name: Test and publish
 
 on:
-- push
+  push:
+    branches:
+    - main
 
 concurrency:
   group: tests-${{ github.head_ref || github.ref }}

docs/theme/partials/integrations/analytics/goatcounter.html

@@ -0,0 +1,2 @@
+<script data-goatcounter="https://{{ config.extra.analytics.code }}.goatcounter.com/count"
+        async src="//gc.zgo.at/count.js"></script>