Download openMairie Framework Documentation

openMairie Framework Documentation, Version 4.5
Étape 3 : Vérification de l’intervalle
export REVS="$(tail -n2 ../LOG|head -n1|awk '{print $1}'|sed "s/r//"):$(head -n2 ../LOG|tail -n1|a
echo $REVS
Étape 4 : Récupération de tous les commits (très long)
svn2git --authors ../authors-transform.txt --revision $REVS -v svn://scm.adullact.net/scmrepos/svn
Étape 5 : Import du code sur github
git remote add origin [email protected]:openmairie/${NEWPRODUCTNAME}-documentation.git
git push -u --all
git push --tags
Étape 6 : Suppression de l’ancien dépôt de documentation sur l’adullact pour que personne ne committe dessus
svn del -m "Déplacement de la documentation vers Github" svn+ssh://${ADULLACTUSER}@scm.adullact.ne
echo "Documentation déplacée vers https://github.com/openmairie/${NEWPRODUCTNAME}-documentation" >
svn import -m "Déplacement de la documentation vers Github" ../MOVED-TO-GITHUB.txt svn+ssh://${ADU
6.1.7.3 Faire l’import initial d’un projet sphinx
Public(s) concerné(s) : Administrateur de projet openMairie.
6.1.7.4 Contribuer à une documentation
Public(s) concerné(s) : Contributeur membre du projet openMairie.
6.1.8 readthedocs.org
readthedocs.org est un site qui héberge de la documentation, la rendant accessible et facile à trouver. Il est possible d’importer les documentations sur ce site depuis les système de gestion de version tel que Subversion, Git
ou d’autres. Ce site permet de gérer la mise à jour automatique des documentations à chaque commit dans ces
systèmes de gestion de version. Le site supporte également le support des versions mais seulement pour Git et non
pas pour Subversion à l’heure où cette documentation est rédigée.
L’objectif d’utiliser ce site est donc de ne pas avoir à se soucier de la génération des documentations. C’est
ReadTheDcs.org qui s’en occupe et dans tous les formats html, pdf, epub, ...
Pour pouvoir gérer un projet sur ce site, il faut avoir un utilisateur (le bouton “Inscription” en haut à droite de la
page d’acucueil permet d’obtenir un compte utilisateur très facilement).
6.1.8.1 Importer un nouveau projet sur RTD
Public(s) concerné(s) : Administrateur de projet openMairie.
Depuis le tableau de bord de readthedocs.org, un clic sur le bouton “Importer”, permet d’accéder au formulaire de
création d’un projet sphinx existant.
Voici les informations à saisir :
— Nom : le nom du logiciel sans accents sans espaces en minuscules (par exemple : openelec ou openresultat).
— Repo : l’URL de github.com où est stockée le code de la documentation (par
exemple
:
https://github.com/openmairie/openelec-documentation.git
pour
openelec
ou
https://github.com/openmairie/openresultat-documentation.git pour openresultat).
— Type de dépôt : “Git” puisque le dépôt est sur github.com.
— Description : Le nom du logiciel avec accents avec espaces et avec la casse (par exemple : openElec ou
openRésultat).
— Language : “French” puisque la documentation est francophone.
6.1. Outils
147