¿Cómo crear páginas Github desde la documentation de un proyecto?

Tengo un proyecto en Github que tiene un directory que contiene cierta documentation HTML generada automáticamente. Me gustaría utilizar esa documentation dentro de las instalaciones de las páginas del proyecto de Github.

Entonces, he leído las instrucciones sobre cómo crear la twig de raíz gh-páginas del proyecto . Esto efectivamente crea una twig vacía.

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

Respondiendo a mi propia pregunta aquí … he logrado lo que quería con los submodules de Git.

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

  • Movió la ruta de docs a una carpeta temporal. Cometer cambios.
  • Creó una twig limpia de gh-pages según las instrucciones habituales
  • Moví todo de la carpeta temp a la nueva twig gh-pages . Cometer cambios.
  • De vuelta en la twig principal, agregue las gh-pages remotas como un submodule en la carpeta docs .
  • Cometer cambios. Voila!

Mhm, terminé escribiendo estos dos objectives Makefile para impulsar mis documentos. Solo hago 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 puedes cambiar esto a cualquier otro sistema de documentation.

Esto supone que la twig gh-pages existe en el control remoto y se creó como se explica aquí .

crea enlaces simbólicos para esos files en ese punto. Deberías poder cometerlos también.