Merge pull request #201 from tryolabs/versioned-docs

Documentation site for different Norfair versions

.github/workflows/docs.yml

@@ -5,16 +5,9 @@ on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["master"]
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
 # Allow one concurrent deployment
 concurrency:
   group: "docs"
@@ -23,28 +16,22 @@ concurrency:
 jobs:
   # Single deploy job since we're just deploying
   deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Set up Python 3.7
         uses: actions/setup-python@v4
         with:
           python-version: "3.7"
-      - name: Setup MKDocs
+      - name: Setup a user for the commits
+        run: |
+          git config user.name ci-bot 
+          git config user.email [email protected]
+      - name: Installing dependencies
         run: pip install -r docs/requirements.txt
-      - name: Build Docs
-        run: mkdocs build -d docs_site
-      - name: Setup Pages
-        uses: actions/configure-pages@v2
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload entire repository
-          path: "docs_site"
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1
+      - name: Updating "dev"
+        run: mike deploy --push dev
+

docs/css/custom.css

@@ -1,7 +1,7 @@
-:root > * {
-    --md-primary-fg-color: #0B0723;
-  }
+:root>* {
+  --md-primary-fg-color: #0B0723;
+}
 
-.md-header__topic{
+.md-header__topic>.md-ellipsis {
   opacity: 0;
-}
+}

docs/requirements.txt

@@ -1,4 +1,5 @@
 mkdocs-material==8.4.1
 mkdocstrings[python]==0.19.0
 mkdocs-autorefs==0.4.1
-mkdocs-gen-files==0.4.0
+mkdocs-gen-files==0.4.0
+mike==1.1.2

mkdocs.yml

@@ -50,6 +50,13 @@ plugins:
   - gen-files:
       scripts:
       - docs/gen_index.py
+  - mike:
+      version_selector: true
+
+extra:
+  version:
+    provider: mike
+    default: latest
 
 markdown_extensions:
     - toc: