Set up GitHub Pages with MkDocs

- Add GitHub Pages deployment workflow (.github/workflows/docs.yml)
- Configure MkDocs for GitHub Pages with site_url and plugins
- Update documentation badges to point to GitHub Pages
- Streamline navigation for existing content
- Ready for deployment at https://fourms.github.io/MGT-python/

Author: Alexander Refsum Jensenius

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+          
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
+          
+      - name: Build documentation
+        run: mkdocs build --clean
+        
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+        
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: './site'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -3,12 +3,14 @@
 [![PyPi version](https://badgen.net/pypi/v/musicalgestures/)](https://pypi.org/project/musicalgestures)
 [![GitHub license](https://img.shields.io/github/license/fourMs/MGT-python.svg)](https://github.com/fourMs/MGT-python/blob/master/LICENSE)
 [![CI](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml)
-[![Documentation Status](https://readthedocs.org/projects/mgt-python/badge/?version=latest)](https://mgt-python.readthedocs.io/en/latest/?badge=latest)
+[![Documentation](https://github.com/fourMs/MGT-python/actions/workflows/docs.yml/badge.svg)](https://fourms.github.io/MGT-python/)
 
 The **Musical Gestures Toolbox for Python** is a comprehensive collection of tools for visualization and analysis of audio and video, with a focus on motion capture and musical gesture analysis.
 
 ![MGT python](https://raw.githubusercontent.com/fourMs/MGT-python/master/musicalgestures/documentation/figures/promo/ipython_example.gif)
 
+📖 **[📚 Full Documentation & Examples](https://fourms.github.io/MGT-python/)**
+
 ## Quick Start
 
 ### Installation

docs/index.md

@@ -3,7 +3,7 @@
 [![PyPi version](https://badgen.net/pypi/v/musicalgestures/)](https://pypi.org/project/musicalgestures)
 [![GitHub license](https://img.shields.io/github/license/fourMs/MGT-python.svg)](https://github.com/fourMs/MGT-python/blob/master/LICENSE)
 [![CI](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fourMs/MGT-python/actions/workflows/ci.yml)
-[![Documentation Status](https://readthedocs.org/projects/mgt-python/badge/?version=latest)](https://mgt-python.readthedocs.io/en/latest/?badge=latest)
+[![Documentation](https://github.com/fourMs/MGT-python/actions/workflows/docs.yml/badge.svg)](https://fourms.github.io/MGT-python/)
 
 The **Musical Gestures Toolbox for Python** is a comprehensive collection of tools for visualization and analysis of audio and video, with a focus on motion capture and musical gesture analysis.
 
@@ -111,7 +111,7 @@ If you use MGT-python in your research, please cite:
 @software{mgt_python,
   title={Musical Gestures Toolbox for Python},
   author={University of Oslo fourMs Lab},
-  url={https://github.com/fourMs/MGT-python},
+  url={https://fourms.github.io/MGT-python/},
   version={1.3.2},
   year={2024}
 }

mkdocs.yml

@@ -1,5 +1,6 @@
 site_name: "MGT-python: Musical Gestures Toolbox"
 site_description: "Musical Gestures Toolbox for Python - Tools for visualization and analysis of audio and video"
+site_url: "https://fourms.github.io/MGT-python/"
 repo_url: "https://github.com/fourMs/MGT-python/"
 edit_uri: "edit/master/docs/"
 site_dir: "site"
@@ -15,6 +16,8 @@ theme:
     - navigation.top
     - search.highlight
     - content.code.copy
+    - content.action.edit
+    - content.action.view
   palette:
     - scheme: default
       primary: indigo
@@ -29,6 +32,11 @@ theme:
         icon: material/brightness-4
         name: Switch to light mode
 
+plugins:
+  - search
+  - git-revision-date-localized:
+      enable_creation_date: true
+
 nav:
   - Home: index.md
   - Getting Started:
@@ -37,12 +45,8 @@ nav:
     - Examples: examples.md
   - User Guide:
     - Core Classes: user-guide/core-classes.md
-    - Video Processing: user-guide/video-processing.md
-    - Audio Analysis: user-guide/audio-analysis.md
-    - Motion Analysis: user-guide/motion-analysis.md
-    - Visualization: user-guide/visualization.md
   - API Reference:
-    - musicalgestures/index.md
+    - Overview: musicalgestures/index.md
     - Video: musicalgestures/_video.md
     - Audio: musicalgestures/_audio.md
     - Flow: musicalgestures/_flow.md
@@ -51,15 +55,11 @@ nav:
     - Complete Reference: MODULES.md
   - Development:
     - Contributing: contributing.md
-    - Testing: testing.md
-    - Release Notes: releases.md
 
 plugins:
   - search
-  - mkdocstrings:
-      handlers:
-        python:
-          paths: [musicalgestures]
+  - git-revision-date-localized:
+      enable_creation_date: true
 
 markdown_extensions:
   - admonition