Docs/versioned docs (#236) (#237)

* Docs/versioned docs (#236)

* 🔧 build: add mkdocs to project

* 📝 docs: rewrite getting started page to mkdocs structure
note:
mkdocstrings still has to be added to support linking to library code

* 📝 docs: translate dash app integration page to mkdocs structure

* 📝 docs: translate FAQ page to mkdocs structure

* 🔧 build: add mkdocstrings dependency

* 🔧 build: add mkdocs-gen-files dependency

* 🔧 build: add automatic code API reference page creation

* 📝 docs: fix links to API documentation

* 📝 build: add mkdocs-section-index

* 📝 docs: fix registering documentation

* 📝 docs: fix docs for figure_resampler dir

* 📝 docs: fix aggregation documentation

* 📝 docs: add versioning to documentation

* 🔥 chore: remove old documentation

* 👷 build: add mkdocs CI/CD step

* 🔧 build: add QOL docs extensions

* 📝 docs: add buttons for github, PyPi and DOI

* ➖ chore: remove old sphinx dependencies

* 🎨 chore: format code documentation

* ✏️ chore: remove random text in docstring

* 🎨 chore: format code

* 👷 build: replace tag push with PR push

* Docs/versioned docs (#238)

* 🔧 build: add mkdocs to project

* 📝 docs: rewrite getting started page to mkdocs structure
note:
mkdocstrings still has to be added to support linking to library code

* 📝 docs: translate dash app integration page to mkdocs structure

* 📝 docs: translate FAQ page to mkdocs structure

* 🔧 build: add mkdocstrings dependency

* 🔧 build: add mkdocs-gen-files dependency

* 🔧 build: add automatic code API reference page creation

* 📝 docs: fix links to API documentation

* 📝 build: add mkdocs-section-index

* 📝 docs: fix registering documentation

* 📝 docs: fix docs for figure_resampler dir

* 📝 docs: fix aggregation documentation

* 📝 docs: add versioning to documentation

* 🔥 chore: remove old documentation

* 👷 build: add mkdocs CI/CD step

* 🔧 build: add QOL docs extensions

* 📝 docs: add buttons for github, PyPi and DOI

* ➖ chore: remove old sphinx dependencies

* 🎨 chore: format code documentation

* ✏️ chore: remove random text in docstring

* 🎨 chore: format code

* 👷 build: replace tag push with PR push

* 👷 build: fix mike deployment

* Docs/versioned docs (#239)

* 🔧 build: add mkdocs to project

* 📝 docs: rewrite getting started page to mkdocs structure
note:
mkdocstrings still has to be added to support linking to library code

* 📝 docs: translate dash app integration page to mkdocs structure

* 📝 docs: translate FAQ page to mkdocs structure

* 🔧 build: add mkdocstrings dependency

* 🔧 build: add mkdocs-gen-files dependency

* 🔧 build: add automatic code API reference page creation

* 📝 docs: fix links to API documentation

* 📝 build: add mkdocs-section-index

* 📝 docs: fix registering documentation

* 📝 docs: fix docs for figure_resampler dir

* 📝 docs: fix aggregation documentation

* 📝 docs: add versioning to documentation

* 🔥 chore: remove old documentation

* 👷 build: add mkdocs CI/CD step

* 🔧 build: add QOL docs extensions

* 📝 docs: add buttons for github, PyPi and DOI

* ➖ chore: remove old sphinx dependencies

* 🎨 chore: format code documentation

* ✏️ chore: remove random text in docstring

* 🎨 chore: format code

* 👷 build: replace tag push with PR push

* 👷 build: fix mike deployment

* Docs/versioned docs (#240)

* 🔧 build: add mkdocs to project

* 📝 docs: rewrite getting started page to mkdocs structure
note:
mkdocstrings still has to be added to support linking to library code

* 📝 docs: translate dash app integration page to mkdocs structure

* 📝 docs: translate FAQ page to mkdocs structure

* 🔧 build: add mkdocstrings dependency

* 🔧 build: add mkdocs-gen-files dependency

* 🔧 build: add automatic code API reference page creation

* 📝 docs: fix links to API documentation

* 📝 build: add mkdocs-section-index

* 📝 docs: fix registering documentation

* 📝 docs: fix docs for figure_resampler dir

* 📝 docs: fix aggregation documentation

* 📝 docs: add versioning to documentation

* 🔥 chore: remove old documentation

* 👷 build: add mkdocs CI/CD step

* 🔧 build: add QOL docs extensions

* 📝 docs: add buttons for github, PyPi and DOI

* ➖ chore: remove old sphinx dependencies

* 🎨 chore: format code documentation

* ✏️ chore: remove random text in docstring

* 🎨 chore: format code

* 👷 build: replace tag push with PR push

* 👷 build: fix mike deployment

* 👷 build: fix git gh-pages fetching

* 🖍️ review

* 👷 build: create docs on tag push

---------

Co-authored-by: Niels Praet <[email protected]>
Co-authored-by: Niels Praet <[email protected]>

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,47 @@
+name: Deploy docs
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Cache Poetry
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}-python-3.8
+
+      - run: poetry --version
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: fetch from gh-pages
+        run: git fetch origin gh-pages --depth=1
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Deploy with mike
+        run: |
+          poetry run mike deploy -b gh-pages --update-aliases --push "${{ github.ref_name }}" "latest"