Wie lädt ich die HTML -Dokumentation hoch, die von Sphinx zu GitHub generiert wurde?

Question

Ich habe gerade Ladungen meines Codes dokumentiert und gelernt, wie man Sphinx verwendet, um die Dokumentation zu generieren. Ich möchte das in meine GitHub -Projektseite einbeziehen, aber ich weiß nicht, wie es geht. Kennt jemand das vorhandene Tutorial oder einen einfachen Schritt dazu?

Vielen Dank.

Answer 1

Github wird statische Inhalte für Sie verwenden, indem Sie ihre verwenden Github -Seiten Besonderheit. Im Wesentlichen erstellen Sie einen Zweig namens GH-Seiten, in dem Sie Ihre statischen Seiten begehen. Die Seiten werden dann bei Ihnen serviert.github.com/yourProject.

Siehe die Anweisungen bei http://pages.github.com/.

Sie werden wahrscheinlich ein Problem mit Sphinx auf GitHub begegnen, da Sphinx Verzeichnisse mit führenden Unterstrichen verwendet. Sie können dies beheben, indem Sie eine Datei mit dem Titel hinzufügen .nojekyll im Verzeichnis mit dem erzeugten Sphinx HTML.

Answer 2

John Pauletts Antwort ist offensichtlich korrekt und für die meisten Benutzer wahrscheinlich bereits ausreichend (+1).

Alternativ möchten Sie sich vielleicht Ben Welshs gründliches Tutorial ansehen Sphinx -Dokumentation auf GitHub, die Schritt -für -Schritt -Anweisungen sowie bequeme Anweisungen erhalten Stoff basierte Skript/Aufgabe, die diese zusammenbinden, damit Sie beginnen Veröffentlichen Sie schnell die Dokumentation zusammen mit Ihrem Code [... über einen einzigen Befehl.

Answer 3

Github-Tools Hat eine Funktion, die genau das tut, was Sie fragen:

paver gh_pages_create gh_pages_build

Beziehen Sie sich auf die Ausgezeichnete Dokumentation (Natürlich verwenden Sie sich selbst), wie Sie es für Ihr Projekt einrichten können.