Generar documentación de Symfony2

Si queremos aprender a trabajar con Symfony no hay nada como acceder a la documentación oficial. Sin embargo, puede que no estemos online en un momento dado o que simplemente querramos disponer de la documentación en un formato portable para visualizarla cómodamente en una tablet o un ebook. En estas breves líneas aprenderemos a generarnos la documentación en formato HTML o PDF a partir del repositorio Github
Para empezar, mencionar que todo esto lo estoy realizando desde Ubuntu 11.04. Bien, lo primero que haremos será instalar las herramientas necesarias: Sphinx y Tex Live.

sudo apt-get install python-setuptools
sudo easy_install -U Sphinx
sudo apt-get install texlive-full

Una vez hecho esto, nos descargamos la documentación de Symfony2 y la extensión de Sphinx creada por Fabien Potencier.

git clone https://github.com/symfony/symfony-docs.git
git clone https://github.com/fabpot/sphinx-php.git

Ahora tenemos que ejecutar el asistente de configuración de Sphinx, pero antes de eso, vamos a renombrar el fichero index.rst dentro de symfony-docs con cualquier otro nombre, ya que el asistente nos va a generar otro fichero index.rst.

sphinx-quickstart

Dejamos todas las opciones por defecto, excepto la extensión autodoc, que deberemos activarla. Una vez completado el asistente, borramos el fichero index.rst y volvemos a renombrar el fichero original.
Ya sólo nos queda instalar la extensión para Sphinx creada por Fabien: configuration-block. Para ello, dentro del directorio symfony-docs creamos un nuevo directorio _exts y copiamos dentro el fichero configurationblock.py. Ahora buscamos el fichero conf.py y justo después de añadimos

sys.path.append(os.path.abspath('_exts'))

después buscamos el array de extensiones y añadimos el configurationblock

extensions = ['sphinx.ext.autodoc', 'configurationblock']

Bien, todo listo, ahora sólo hay que generar la documentación

make html
make latexpdf

y buscarla en el directorio _build.

Categoría: Programación  Etiquetas: , , ,
Puedes seguir los comentarios de esta entrada a través del feed RSS 2.0. Puedes dejar un comentario, o un trackback hacia tu propio sitio web.
2 respuestas
  1. antharez dice:

    Buen tutorial, salvo que para instalar el packete texlive-full en ubuntu 11.04 debo bajar como 1Gb de archivos, demaciado.

    Sabes si existe otra solución?, vi que tetex puede servir pero no lo he probado.

    Saludos

  2. Osukaru dice:

    La verdad es que no lo sé, pero si descubres algo comentalo por aquí para tenerlo en cuenta. El Tex Live sólo es para la documentación en PDF, ya que se usa LaTeX, para generarla en HTML no hace falta. La primera vez que intenté generar la documentación tuve errores y una de las cosas que hice fue instalar el paquete texlive-full, que tampoco me solucionó el problema del todo, pero luego sobre una instalación limpia pues no arriesgué e instalé tal como he puesto en el tutorial. A lo mejor con textlive normal vale, y si no prueba con tetex a ver qué tal y nos cuentas. Suerte!!!

Deja un comentario

XHTML: Puedes usar los siguientes tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Better Tag Cloud