Merge pull request CCBR#109 from CCBR/docs-update

use mkdocs + mike for docs website

.github/workflows/docs-mkdocs.yml

@@ -0,0 +1,28 @@
+name: docs
+# this workflow requires:
+#  - an mkdocs config file (`mkdocs.yml`)
+#  - website dependencies in `docs/requirements.txt`
+on:
+  workflow_dispatch:
+  release:
+    types:
+      - published
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "**.md"
+      - .github/workflows/docs-mkdocs.yml
+      - mkdocs.yml
+
+jobs:
+  mkdocs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: CCBR/actions/[email protected]
+        with:
+          github-token: ${{ github.token }}

.github/workflows/draft-release.yml

@@ -0,0 +1,25 @@
+name: draft-release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version-tag:
+        description: |
+          Semantic version tag for next release.
+          If not provided, it will be determined based on conventional commit history.
+          Example: v2.5.11
+        required: false
+        type: string
+        default: ""
+
+jobs:
+  draft-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # required to include tags
+      - uses: CCBR/actions/[email protected]
+        with:
+          github-token: ${{ github.token }}
+          version-tag: ${{ github.event.inputs.version-tag }}

.github/workflows/post-release.yml

@@ -0,0 +1,17 @@
+name: post-release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: CCBR/actions/[email protected]
+        with:
+          github-token: ${{ github.token }}

mkdocs.yml

@@ -4,6 +4,7 @@ site_author: Vishal Koparde, Ph.D.
 # Repository
 repo_name: CCBR/spacesavers2
 repo_url: https://github.com/CCBR/spacesavers2
+edit_uri: https://github.com/CCBR/spacesavers2/edit/main/
 
 # Copyright
 copyright: Copyright © 2023 CCBR
@@ -76,8 +77,8 @@ markdown_extensions:
   - pymdownx.critic
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
   - pymdownx.highlight
   - pymdownx.inlinehilite
   - pymdownx.keys