¿Cómo cargar la documentación HTML generada de Sphinx a GitHub?

Question

Acabo de documentar muchas de mi código y aprendí a usar Sphinx para generar la documentación. Quiero incluir eso en mi página del proyecto GitHub, pero no sé cómo hacerlo. ¿Alguien sabe tutorial existente o un paso simple para hacerlo?

Gracias.

Answer 1

GitHub servirá contenido estático para usted utilizando su Páginas de Github rasgo. Esencialmente, crea una rama llamada GH-PAGE, en la que comete sus páginas estáticas. Las páginas se sirven en usted.github.com/yourproject.

Ver las instrucciones en http://pages.github.com/.

Es probable que tenga un problema con Sphinx en GitHub, porque Sphinx utiliza directorios con subrayos líderes. Puede solucionar esto agregando un archivo llamado .nojekyll En el directorio con el Sphinx HTML generado.

Answer 2

Respuesta de John Paulett obviamente es correcto y probablemente suficiente para la mayoría de los usuarios (+1).

Alternativamente, es posible que desee consultar el tutorial exhaustivo de Ben Welsh Documentación de Sphinx en Github, que proporciona instrucciones paso a paso, así como una conveniente Tela Script/tarea basada que une a ellos para comenzar a comenzar a Publique rápidamente la documentación junto con su código [... a través de un solo comando.

Answer 3

github-tools tiene una función que hace exactamente lo que está pidiendo:

paver gh_pages_create gh_pages_build

Referirse a Excelente documentación (por supuesto que se usa) sobre cómo configurarlo para su proyecto.