tab - git tags best practices

¿Cómo crear páginas Github a partir de la documentación de un proyecto?

Question

Tengo un proyecto en Github que tiene un directorio que contiene alguna documentación HTML generada automáticamente. Me gustaría usar esa documentación dentro de las instalaciones de las páginas de proyectos de Github.

Por lo tanto, he leído las instrucciones sobre cómo crear la rama raíz de gh-pages del proyecto . Esto crea efectivamente una rama vacía.

Con lo que me gustaría ayuda es duplicar los archivos html en la ruta /docs desde la rama master , por lo que están en la raíz de la rama gh-pages . ¿Cuál es la mejor manera de abordar esto?

Answer 1

Mhm, terminé escribiendo estos dos objetivos de Makefile para empujar mis documentos. Acabo de hacer update-doc y generalmente funciona.

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

Yo uso doxygen pero podría cambiarlo a cualquier otro sistema de documentación.

Esto supone que la rama gh-pages existe en el control remoto y se creó como se explica here .

Answer 2

Respondiendo a mi propia pregunta aquí ... he logrado lo que quería con los submódulos de Git.

Básicamente copié lo que se detalla en esta tarea de sake , pero en resumen:

• Se movió la ruta de docs en una carpeta temporal. Cometer cambios.
• Creó una rama de gh-pages limpia según las instrucciones habituales.
• Se movió todo de la carpeta temporal a la nueva rama de gh-pages . Cometer cambios.
• De vuelta en la rama maestra, agregue las gh-pages remotas como un submódulo en la carpeta de docs .
• Cometer cambios. Voila!

Answer 3

crear enlaces simbólicos para esos archivos a ese lugar. Usted debe ser capaz de cometer esos también.