Acabo de documentar cargas de mi código y aprendí a usar esfinge para generar la documentación. Quiero incluir eso en mi página de proyecto github, pero no sé cómo hacerlo. ¿Alguien sabe un tutorial existente o un simple paso para hacerlo?¿Cómo subir la documentación html generada desde sphinx a github?
Gracias.
github servirá contenido estático para usted utilizando su característica github pages. Esencialmente, creas una rama llamada gh-pages, en la cual comprometes tus páginas estáticas. Las páginas se sirven en you.github.com/yourproject.
Consulte las instrucciones en http://pages.github.com/.
Es probable que se encuentre con un problema al usar Sphinx en github, porque Sphinx usa directorios con caracteres de subrayado iniciales. Puede solucionar esto agregando un archivo llamado .nojekyll en el directorio con sphinx html generado.
github-tools tiene una característica que hace exactamente lo que está pidiendo:
paver gh_pages_create gh_pages_build
Consulte la excellent documentation (por supuesto el uso de sí mismo) para saber cómo configurarlo para su proyecto.
John Paulett's answer es obviamente correcto y probablemente suficiente para la mayoría de los usuarios (+1).
Alternativamente es posible que desee echa un vistazo a tutorial completo de Ben Welsh Sphinx documentation on GitHub, que proporciona instrucciones paso a paso, así como un cómodo Fabric guión basado/tarea de asociar esos juntos para que pueda empezar a rápidamente publicar la documentación junto con su código [. ..] a través de un solo comando.
El enlace de las instrucciones está roto. – mac
'.nojekyll' punta es salvavidas. Ojalá hubiera leído esto antes. Nota adicional: agréguelo a la raíz de su árbol html. – Jayesh
Enlace para lo que @Jayesh dijo anteriormente: https://github.com/blog/572-bypassing-jekyll-on-github-pages – Gabriel