Come creare pagine GitHub dalla documentazione di un progetto?

Question

Ho un progetto su GitHub che ha una directory contenente una documentazione HTML generata automaticamente. Vorrei utilizzare quella documentazione all'interno della struttura di Pagine di progetto di GitHub.

Quindi, ho letto le istruzioni su come farlo Crea il ramo radice del GH-Pages del progetto. Questo crea efficacemente un ramo vuoto.

Quello che mi piacerebbe aiutare è rispecchiare i file HTML nel /docs percorso dal master ramo, così sono nella radice del gh-pages ramo. Qual è il modo migliore per avvicinarsi a questo?

Answer 1

Rispondere alla mia domanda qui ... ho raggiunto ciò che volevo con i sottomoduli Git.

Fondamentalmente ho copiato ciò che è dettagliato in questo compito di sake, ma in sintesi:

• Spostato il docs percorso in una cartella temperatura. Commettere cambiamenti.
• Creato un pulito gh-pages ramo secondo il Istruzioni solite
• Spostato tutto dalla cartella temporanea al nuovo gh-pages ramo. Commettere cambiamenti.
• Di nuovo nel ramo principale, aggiungi il telecomando gh-pages come sottomodulo in docs cartella.
• Commettere cambiamenti. Ecco!

Answer 2

MHM, ho finito per scrivere questi due obiettivi di makefile per spingere i miei documenti. Faccio solo aggiornamenti e generalmente funziona.

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

Io uso doxygen Ma potresti cambiarlo in qualsiasi altro sistema di documentazione.

Questo assume il gh-pages Branch esiste sul telecomando ed è stato creato come spiegato qui.

Answer 3

Crea symlink per quei file in quel punto. Dovresti essere in grado di commettere anche quelli.