Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
Documentación<br />
Una vez hecho esto podemos acceder a la documentación de <strong>todos</strong><br />
los módulos disponibles abriendo la página http://localhost:puerto en<br />
nuestro navegador.<br />
Por último, mediante el flag -g podemos lanzar una interfaz gráfica<br />
<strong>para</strong> buscar documentación que utiliza el servidor HTTP <strong>para</strong> mostrar<br />
los resultados.<br />
Epydoc y reStructuredText<br />
El problema de pydoc es que es muy simple, y no permite añadir<br />
semántica o modificar estilos de la documentación. No podemos, por<br />
ejemplo, indicar que en una línea en concreto de entre las líneas de<br />
documentación de la función describe un parámetro de la función o<br />
mostrar un cierto término en cursiva.<br />
Existen proyectos <strong>para</strong> generar documentación con funcionalidades<br />
más avanzadas como Docutils, Epydoc o Sphinx, aunque es necesario<br />
aprender sintaxis especiales.<br />
Docutils es un proyecto desarrollado por David Goodger que incluye<br />
distintas herramientas <strong>para</strong> generar documentación utilizando<br />
el formato reStructuredText, un formato de texto plano creado por<br />
el mismo autor, y que es el formato más utilizado en la comunidad<br />
<strong>Python</strong>. reStructuredText se utiliza, entre otros, <strong>para</strong> la creación de los<br />
PEPs (<strong>Python</strong> Enhancement Proposals).<br />
Sin embargo, actualmente Docutils es más indicado <strong>para</strong> generar<br />
documentos a partir de archivos de texto, y no a partir de docstrings<br />
extraídos de código fuente <strong>Python</strong>, ya que el parser encargado de este<br />
trabajo dista mucho de estar terminado.<br />
EpyDoc es una de las herramientas de generación de documentación<br />
<strong>para</strong> <strong>Python</strong> más utilizadas. Además de texto plano y de su propio<br />
formato, llamado epytext, soporta reStructuredText y sintaxis Javadoc,<br />
cosa que los programadores Java agradecerán.<br />
A lo largo del resto del capítulo utilizaremos reStructuredText como<br />
127