Astuce - GitHub Pages - Githubissues

georchestra / georchestra_documentation

Gathering of all geOrchestra's documentation

1 stars 2 forks source link

Astuce - GitHub Pages #12

Open Gaetanbrl opened 1 year ago

Gaetanbrl commented 1 year ago

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

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

cd /mon/projet
mkdir docs

Dans un autre répertoire en dehors de votre projet, cloner la documentation
Copier tout dans /votre/projet/docs sauf les fichier GitHub type .git
Suivre les étapes indiquer dans le README
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

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

MaelREBOUX commented 1 year ago

Nice.

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