Tweaks to mike's config

Author: mdbenito

.github/workflows/publish.yaml

@@ -72,8 +72,8 @@ jobs:
         uses: ./.github/actions/deploy-docs
         with:
           version: ${{ env.CURRENT_VERSION }}
-          alias: stable
-          title: Stable
+          alias: latest
+          title: Latest
           email: ${{ env.GITHUB_BOT_EMAIL }}
           username: ${{ env.GITHUB_BOT_USERNAME }}
           set-default: 'true'

.github/workflows/tox.yaml

@@ -112,8 +112,8 @@ jobs:
         uses: ./.github/actions/deploy-docs
         with:
           version: devel
-          alias: latest
-          title: Latest
+          alias: develop
+          title: Development
           email: ${{ env.GITHUB_BOT_EMAIL }}
           username: ${{ env.GITHUB_BOT_USERNAME }}
       - name: Build and publish to TestPyPI

CONTRIBUTING.md

@@ -179,7 +179,8 @@ Examples for hidden imports and plots are available in the notebooks, e.g. in
 ## Documentation
 
 API documentation and examples from notebooks are built with
-[mkdocs](https://www.mkdocs.org/).
+[mkdocs](https://www.mkdocs.org/), with versioning handled by
+[mike](https://github.com/jimporter/mike).
 
 Notebooks are an integral part of the documentation as well, please read
 [the section on notebooks](#notebooks) above.
@@ -191,8 +192,8 @@ done in CI:
 mkdocs build
 ```
 
-Locally, you can use this command instead to continuously rebuild
-documentation on changes to the `docs` and `src` folder:
+Locally, you can use this command instead to continuously rebuild documentation
+on changes to the `docs` and `src` folder:
 
 ```bash
 mkdocs serve
@@ -406,11 +407,11 @@ If running in interactive mode (without `-y|--yes`), the script will output a
 summary of pending changes and ask for confirmation before executing the
 actions.
 
-Once this is done, a tag will be created on the repository. 
-You should then create a Github
+Once this is done, a tag will be created on the repository. You should then
+create a GitHub
 [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
-for that tag. That will a trigger a CI pipeline that will
-automatically create a package and publish it from CI to PyPI.
+for that tag. That will a trigger a CI pipeline that will automatically create a
+package and publish it from CI to PyPI.
 
 ### Manual release process
 

mkdocs.yml

@@ -4,6 +4,7 @@ site_url: "https://appliedai-initiative.github.io/pyDVL/"
 repo_name: "appliedAI-Initiative/pyDVL"
 repo_url: "https://github.com/appliedAI-Initiative/pyDVL"
 copyright: "Copyright © AppliedAI Institute gGmbH"
+remote_branch: gh-pages
 
 watch:
   - src/pydvl
@@ -30,7 +31,8 @@ plugins:
       auto_caption: true
       caption_position: bottom
   - macros
-  - mike
+  - mike:
+      canonical_version: stable
   - search
   - section-index
   - alias: