diff --git a/.github/workflows/create-docs.yml b/.github/workflows/create-docs.yml index e8353aa..57496e8 100644 --- a/.github/workflows/create-docs.yml +++ b/.github/workflows/create-docs.yml @@ -1,6 +1,9 @@ name: Publish docs via GitHub Pages on: + workflow_call: + workflow_dispatch: push: + branches: [ main ] jobs: build: diff --git a/documentation/docs/developpeur/documentation/a-propos.md b/documentation/docs/developpeur/documentation/a-propos.md index 9925042..c97bf3e 100644 --- a/documentation/docs/developpeur/documentation/a-propos.md +++ b/documentation/docs/developpeur/documentation/a-propos.md @@ -1,4 +1,18 @@ # A propos +## Lancer la documentation +Pour lancer la documentation, il faut installer python et entrer dans le dossier documentation. +Il faut ensuite installer les dépendances avec `pip install -r requirements.txt`. +Pour lancer le mode développement il faut executer `python -m mkdocs serve` + +## Deploiement +Le code est automatiquement déployé par la github-action `create-docs.yaml` +Celle-ci ouvre le repo et fait les memes étapes que "lancer la documentation". +Il y a une différence, elle utilise `build` au lieu de `serve` pour ensuite publier avec l'outil [`ghp-import`](https://github.com/c-w/ghp-import). +La page est poussée sur la branche [`gh-pages`](https://github.com/ets-cfuhrman-pfe/EvalueTonSavoir/tree/gh-pages) et ensuite publié en tant que [gh-page](https://pages.github.com/) + +## Themes et Plugins +Si vous ajoutez des plugins, veuillez mettre a jour le fichier `requirements.txt`. + La documentation utilise [MkDocs](https://www.mkdocs.org/) avec [le theme matérial]((https://squidfunk.github.io/mkdocs-material/)). Il y a bien des fonctionalitées tel que les code-blocks qui peuvent être activés. Vous pouvez avoir accès a la documentation ici : [https://squidfunk.github.io/mkdocs-material/reference/code-blocks/](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) \ No newline at end of file