From dd5f10f11d993a3b23ecd2b3bfe0772fe073aae2 Mon Sep 17 00:00:00 2001 From: Ludee Date: Mon, 14 Aug 2023 11:03:23 +0200 Subject: [PATCH] Update documentation to diable GitHub Action #36 --- docs/development/documentation/index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/development/documentation/index.md b/docs/development/documentation/index.md index 5134d83..e75a124 100644 --- a/docs/development/documentation/index.md +++ b/docs/development/documentation/index.md @@ -30,12 +30,17 @@ Generate the documentation locally.
Publish documentation on **GitHub Pages**.
💻 `mkdocs gh-deploy` manually deploys the documentation files -#### GitHub Action +#### GitHub Action (deprecated) 🐙 Deploy the documentation with **GitHub Actions**.
The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow.
It is configured to be pushed to the branch `gh-page` and then deployed online.
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.
💻 `pip install mike` install mike