Ich habe gerade eine Menge Code dokumentiert und gelernt, wie man mit sphinx die Dokumentation erstellt. Ich möchte das in meine GitHub-Projektseite aufnehmen, aber ich weiß nicht wie. Kennt jemand bereits vorhandenes Tutorial oder einfachen Schritt dazu?Wie lade ich die von sphinx erzeugte HTML-Dokumentation auf github hoch?
Danke.
github liefert statischen Inhalt für Sie mit ihrer github pages Funktion. Im Wesentlichen erstellen Sie einen Zweig namens gh-pages, in den Sie Ihre statischen Seiten einbinden. Die Seiten werden dann auf you.github.com/yourproject bereitgestellt.
Siehe Anweisungen unter http://pages.github.com/.
Sie werden wahrscheinlich ein Problem mit Sphinx auf Github haben, da Sphinx Verzeichnisse mit führenden Unterstrichen verwendet. Sie können dies beheben, indem Sie eine Datei namens .nojekyll im Verzeichnis mit der generierten Sphinx-HTML-Datei hinzufügen.
github-tools verfügt über eine Funktion genau das tun, was Sie fordern:
paver gh_pages_create gh_pages_build
Siehe die excellent documentation (natürlich selbst verwendet wird), wie es für das Projekt einzurichten.
John Paulett's answer ist offensichtlich korrekt und wahrscheinlich ausreichend für die meisten Benutzer bereits (+1).
Alternativ könnten Sie ausführliche Anleitung Ben Welsh Sphinx documentation on GitHub zu überprüfen, die auch Anweisungen Schritt für Schritt bietet eine bequeme Fabric basiertes Skript/Aufgabe diejenigen zusammen binden Sie schnell veröffentlichen Dokumentation neben Ihrem Code [zu erhalten begonnen. ..] über einen einzigen Befehl.
Der Link für die Anweisungen ist gebrochen. – mac
'.nojekyll' Tipp ist Lebensretter. Ich wünschte, ich hätte das früher gelesen. Weitere Anmerkung: fügen Sie es dem Stamm Ihrer HTML-Struktur hinzu. – Jayesh
Link für was @Jayesh oben gesagt: https://github.com/blog/572-bypassing-jekyll-on-github-pages – Gabriel