Update documentation to diable GitHub Action #36

rl-institut · Aug 14, 2023 · dd5f10f · dd5f10f
1 parent 17d1d74
commit dd5f10f
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/docs/development/documentation/index.md b/docs/development/documentation/index.md
@@ -30,12 +30,17 @@ Generate the documentation locally. <br>
 Publish documentation on **GitHub Pages**. <br>
 💻 `mkdocs gh-deploy` manually deploys the documentation files
 
-#### GitHub Action
+#### GitHub Action (deprecated)
 🐙 Deploy the documentation with **GitHub Actions**. <br>
 The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow. <br>
 It is configured to be pushed to the branch `gh-page` and then deployed online. <br>
 A commit on the `production` branch triggers the workflow. 
 
+!!! note "Common python styles"
+    This feature is not compatible with the versioning of the documentation with `mike`.
+    The action overrides all manually deployed versions!
+    `This workflow was disabled manually.`
+
 ### Mike
 The package [mike](https://github.com/jimporter/mike) is used to deploy [multiple versions](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=versioning) of the documentation.<br>
 💻 `pip install mike` install mike <br>