Astuce - GitHub Pages

[Gaetanbrl]

Description

Un ticket Astuce pour publier cette documentation sur une GitHub pages sans avoir un seul serveur / web serveur.

Cas d'usage :

• J'ai créé un plugin pour geOrchestra et je veux le documenter avec la documentation geOrchestra
• J'ai créé une librairie, je souhaite réutiliser le template documentation geOrchestra

Etapes

1. Aller dans le répertoire de votre projet, et y créer un répertoire /docs

cd /mon/projet
mkdir docs

2. Dans un autre répertoire en dehors de votre projet, cloner la documentation

3. Copier tout dans /votre/projet/docs sauf les fichier GitHub type .git

4. Suivre les étapes indiquer dans le README

5. Utiliser la commande mkdocs gh-deploy (dans votre virtualenv) pour publier la documentation le dépôt git de votre projet > Hébergé par GitHub

cd /docs
mkdocs gh-deploy

6. Ouvrez GitHub et aller dans Settings > Page pour récupérer le lien de votre documentation en ligne !

[MaelREBOUX]

Nice.

À faire dans une page dédiée, au même titre que RTD.