program - python documentation generator

¿Cómo subir la documentación html generada desde la esfinge a github?

Question

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

Gracias.

Answer 1

github ofrecerá contenido estático para usted mediante la función de sus páginas github . Esencialmente, creas una rama llamada gh-pages, en la que ingresas tus páginas estáticas. Las páginas se sirven en you.github.com/yourproject.

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

Probablemente se encontrará con un problema al usar Sphinx en github, porque Sphinx usa directorios con guiones bajos. Puede solucionar esto agregando un archivo llamado .nojekyll en el directorio con el html de esfinge generado.

Answer 2

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

paver gh_pages_create gh_pages_build

Consulte la excelente documentación (por supuesto que se usa a sí misma) para saber cómo configurarlo para su proyecto.

Answer 3

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

Como alternativa, puede consultar el tutorial completo de Ben Welsh Sphinx en GitHub , que proporciona instrucciones paso a paso, así como un conveniente script / tarea basado en Fabric para unirlos y comenzar a publicar rápidamente la documentación junto con su código [... ] a través de un solo comando.