Closed Ludee closed 1 day ago
Using mike to set version numbers to the documentation is working great.
But it is not compatible with an automated GitHub workflow to push the documentation.
When pushing to the production branch, the workflow overrides the branch gh-pages
and all version are deleted.
🐙 The workflow can be deactivated on GitHub: https://docs.github.com/de/enterprise-cloud@latest/actions/using-workflows/disabling-and-enabling-a-workflow
In order to have the version slider on older versions before mike has been implemented, simply add it to mkdocs.yml
after checking out the Git Tag and then register the version with mike.
In order to have the latest develop branch with mike versioning, update the stale GitHub workflow to push the develop branch after a PR.
Successfully implemented
Description of the issue
The documentation is missing versioning. The MkDocs should be specific to each software version.
Ideas of solution
There is a specific package called mike to handle the versions. Sources:
Workflow checklist