Publication de pages web avec gitlab-pages
Principe
- Vous rédigez des fichiers/pages dans un langage type markdown ou rst et sauvegardez (git) ces fichiers dans votre projet gitlab.
- Un outil (sphinx, mkdocs, hugo . . . ) est appelé dans un job d’intégration continue pour générer des pages web statiques (fichiers html et autres).
- gitlab-pages (job CI) pour publier vos pages sur un serveur nommé
.gricad-pages.univ-grenoble-alpes.fr/ .
Les étapes 2 et 3 sont automatiques et gérées par l'intégration continue. Il faut simplement décrire le procédé dans le fichier .gitlab-ci.yml (voir section suivante).
Ecrire le fichier yml
La méthode la plus simple pour créer des pages web est d'utiliser les templates proposés par gitlab.
Pour commencer, partez d'un projet existant mais sans intégration continue ou créez un nouveau projet puis ajoutez un fichier .gitlab-ci.yml à partir d'un template :
Dans la liste des templates, vous trouverez une catégorie 'pages' et des sous-catégories correspondant aux outils standards de génération de site web, Pelican dans notre exemple.
Ensuite il suffit d'ajouter au projet vos fichiers de doc.
De nombreux exemples sont disponibles sur gitlab.com. Voir entre autres un projet utilisant Pelican ou un autre avec doxygen.