Comment créer des pages Github à partir de la documentation d'un projet?
j'ai un projet sur Github qui a un répertoire contenant de la documentation HTML générée automatiquement. Je voudrais utiliser cette documentation dans les pages de projet de Github.
donc, j'ai lu les instructions sur la façon de créer le projet gh-pages branche de la racine. Cela crée effectivement une branche vide.
ce que je voudrais de l'aide avec est miroir les fichiers html dans le /docs chemin à partir du master branche, donc ils sont à la racine de gh-pages branche. Quelle est la meilleure façon d'aborder ce?
3 réponses
Répondre à ma propre question ici... ont accompli ce que je voulais avec Git submodules.
en gros, j'ai copié ce que l' détaillé dans cette tâche de saké, mais en résumé:
- déplacer le
docschemin dans un dossier temporaire. Engager des changements. - Créé un propre
gh-pagesbranche selon le instructions habituelles - tout déplacé du dossier temp dans le nouveau
gh-pagesbranche. Engager changement. - de retour dans la branche principale, ajouter la télécommande
gh-pagescomme un sous-module dans ledocsdossier. - valider les modifications. Voila!
Mhm, j'ai fini par écrire ces deux cibles Makefile pour pousser mes docs. Je fais juste update-doc et ça marche généralement.
TMP_PATH="/tmp/some_path"
## the dir containing HTML docs to push to gh-pages
HTML_DIR="html"
## arbitrary dirs created by the doc build system that should be removed
TRASH=latex
update-doc: doc
rm -rf ${TMP_PATH} && cp ${HTML_DIR} ${TMP_PATH} -R && rm -rf ${HTML_DIR}
git fetch
git checkout gh-pages
cp ${TMP_PATH}/* . -R
rm -rf ${TRASH}
git add .
git commit -m "Update documentation"
git push -u origin gh-pages
rm -rf ${TMP_PATH}
git checkout master
# command to build documentation; can be customised but
# remember to also change the HTML_DIR and TRASH variables
doc:
doxygen docs/doxygen.conf
.PHONY: doc update-doc
j'utilise doxygen mais vous pouvez changer ceci à n'importe quel autre système de documentation.
cela suppose le gh-pages la branche existe sur la télécommande et a été créée comme expliqué ici.
créer des liens symboliques pour les fichiers à cet endroit. Vous devriez être capable de commettre de ceux qui sont trop.