Add mike (#1264)

* check return types

* set site url

* change docs publish to tag, for now comment it out

.github/workflows/deploy-docs.yml

@@ -1,7 +1,9 @@
 name: Build Documentation using MkDocs
 on:
   push:
-    branches: [ master ]
+    # Pattern matched against refs/tags
+    tags:
+      - '**'
 jobs:
   build:
     name: Build and Deploy Documentation
@@ -19,6 +21,12 @@ jobs:
           poetry install --extras "all"
         env:
           POETRY_VIRTUALENVS_CREATE: false
-      - name: Deploy
+      - name: Set env
+        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+      - name: Test
         run: |
-          mkdocs gh-deploy --force
+          echo $RELEASE_VERSION
+          echo ${{ env.RELEASE_VERSION }}
+#      - name: Deploy
+#        run: |
+#          mike deploy --push --update-aliases ${{ env.RELEASE_VERSION }} latest

mkdocs.yml

@@ -1,4 +1,5 @@
 site_name: ormar
+site_url: 'https://collerek.github.io/ormar/'
 site_description: A simple async ORM with fastapi in mind and pydantic validation.
 nav:
   - Overview: index.md
@@ -77,6 +78,10 @@ markdown_extensions:
   - pymdownx.highlight:
       linenums: true
 plugins:
+- mike:
+    alias_type: symlink
+    canonical_version: latest
+    version_selector: true
 - search
 - gen-files:
     scripts:

pyproject.toml

@@ -142,6 +142,7 @@ all = [
 httpx = "^0.24.1"
 asgi-lifespan = "^2.1.0"
 pytest-codspeed = "^2.2.0"
+mike = "^2.0.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]