Sphinx para documentar proyectos y con acentos
Estoy maravillado de lo chingon que es sphinx para generar documentación.
Estos son los comentarios de mis compañeros
Luis: No mames te genera el pdf!
JJ: Hize la documentación mas facil y rapido que pelear en un word.
otro: Tiene otros temas!!!
Bien mientras estuvimos mis compañeros trabajando tuve varios problemas q google no me pudo resolver.
Problema de los acentos.
Este problema es debido a sphinx esta configurado con utf-8 y cuando genera el html pone el codigo feo de utf. Para resolverlo hay que cambiar la configuración:
source_encoding = 'iso-8859-15'
Haciendo esto le dices a sphinx que vas a usar iso-8859. Por lo que tus archivos .rst tambien deben usar este encoding.
file index.rst
index.rst: ISO-8859 text
Al prinicipio me peleaba con los archivos ya que eran de tipo UTF-8 pero hay que cambiarlos el encoding para que sphinx te imprima los acentos y eñes.
iconv --to-code=ISO-8859-1//TRANSLIT \
--from-code=UTF-8 Aplicaciones\ para\ el\ Home.rst -o test.rst
cp test.rst Aplicaciones\ para\ el\ Home.rst
El //TRANSLIT es importante para eviar un error el iconv que no puede generar el archivo por un caracter extraño.
Y ya tengo mi documentación lista para entregar al cliente.