Come caricare la documentazione html generata da sfinge a github?

Question

Ho appena documentato un sacco del mio codice e ho imparato a usare la sfinge per generare la documentazione. Voglio includerlo nella mia pagina del progetto Github ma non so come. Qualcuno conosce tutorial esistenti o semplici passaggi per farlo?

Grazie.

Answer 1

github servirà contenuto statico per voi utilizzando la loro funzione github pages. In sostanza, si crea un ramo chiamato gh-pages, nel quale si impegnano le pagine statiche. Le pagine vengono quindi pubblicate su you.github.com/yourproject.

Vedere le istruzioni su http://pages.github.com/.

Probabilmente incontrerai un problema usando Sphinx su github, perché la Sfinge usa le directory con i trattini bassi. Puoi risolvere questo problema aggiungendo un file chiamato .nojekyll nella directory con lo sphinx html generato.

Answer 2

github-tools ha una funzione di fare esattamente quello che stai chiedendo:

paver gh_pages_create gh_pages_build 

Fare riferimento alla excellent documentation (ovviamente usando stesso) per come configurarlo per il vostro progetto.

Answer 3

John Paulett's answer è ovviamente corretto e probabilmente sufficiente per la maggior parte degli utenti già (+1).

In alternativa si potrebbe voler controllare esercitazione approfondita di Ben Welsh Sphinx documentation on GitHub, che fornisce istruzioni passo passo, nonché una comoda Fabric sceneggiatura basata/compito legare quelli insieme per iniziare a rapidamente pubblicare la documentazione a fianco il codice [. ..] tramite un singolo comando.