Wie erstelle ich GitHub -Seiten aus der Dokumentation eines Projekts?

Question

Ich habe ein Projekt auf GitHub, das ein Verzeichnis mit einer automatisch generierten HTML -Dokumentation enthält. Ich möchte diese Dokumentation in den Projektseiten von Github verwenden.

Also habe ich die Anweisungen dazu gelesen, wie es geht Erstellen Sie die Stammzweig der GH-Pages des Projekts. Dies schafft effektiv einen leeren Zweig.

Was ich gerne helfen würde, spiegelt die HTML -Dateien in der /docs Weg von der master Zweig, also sind sie in der Wurzel der gh-pages Zweig. Was ist der beste Weg, dies zu nähern?

Answer 1

Ich beantworte meine eigene Frage hier ... habe das erreicht, was ich mit Git -Submodules wollte.

Ich habe im Grunde kopiert, was ist In dieser Sake -Aufgabe detailliert, aber zusammenfassend:

• Bewegte die docs Pfad in einen Temperaturordner. Änderungen begehen.
• Eine saubere erstellt gh-pages Zweig gemäß den übliche Anweisungen
• Bewegte alles vom Temperaturordner in den neuen gh-pages Zweig. Änderungen begehen.
• Zurück im Master -Zweig fügen Sie die Fernbedienung hinzu gh-pages als Submodul in der docs Mappe.
• Änderungen begehen. Voila!

Answer 2

MHM, ich habe diese beiden Makefile -Ziele geschrieben, um meine Dokumente zu drücken. Ich mache einfach Update-Doc und es funktioniert im Allgemeinen.

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

ich benutze doxygen Sie könnten dies jedoch in ein anderes Dokumentationssystem ändern.

Dies setzt das an gh-pages Der Zweig gibt es in der Fernbedienung und wurde wie erläutert erstellt hier.

Answer 3

Erstellen Sie Symlinks für diese Dateien an diesem Punkt. Sie sollten auch in der Lage sein, diese zu begehen.