Documentación del código

06/17/2011

De hoy en adelante, iré enlazando la documentación del código de cada componente del proyecto en la sección Documentación, para poder consultarla online.


Nueva versión del Servidor disponible

06/17/2011

Una nueva versión del Servidor (0.2.3) está disponible desde hoy. Sólo tiene cambios menores, pero su código está ya documentado. En el repositorio Subversion del proyecto he modificado el archivo build.sh que genera todos los paquetes del proyecto para que genere también la documentación del proyecto y la documentación del código de cada componente (de momento, sólo la del Servidor). Por tanto, ahora disponemos de un script que genera en 1 sólo paso todos los paquetes instalables del proyecto, la documentación del código de cada componente y la documentación general del proyecto, lo cual facilita mucho el trabajo de liberar cada nueva versión de Predesys.


Versión nueva de la Documentación liberada

06/11/2011

Sigo documento del proyecto, ya que pretendo presentarlo como mi proyecto Fin de Carrera, y desde hoy está disponible una nueva versión (6) de la Documentación. Está disponible en la sección Documentación, como es habitual.


Nueva versión de la Documentación disponible

06/07/2011

Acabo de publicar una nueva versión, la 5, de la Documentación del proyecto. Como siempre, está disponible en formato PDF en la sección Documentación.


Código del Servidor documentado

05/07/2011

De momento, he acabado la documentación del código del Servidor, pero no liberaré una nueva versión del Servidor hasta que haya cambiado algunas cosas del mismo que tengo pendientes. También, tengo pendiente documentar el código de los otros componentes de Predesys.

La documentación del código del Servidor sólo puede verse sobre el propio código; más adelante, cuando libere la nueva versión, dicha documentación estará disponible también en la Documentación del proyecto.


Wiki de LaTeX

04/24/2011

Estoy desarrollando una wiki sencilla sobre LaTeX. Mi idea es que todo lo que vaya aprendiendo sobre LaTeX para la Documentación del proyecto lo vaya volcando sobre la wiki por si le puede servir a alguien. Hay alguna otra wiki muy buena en otro sitio web, pero la mía está orientada a ser muy directa y sencilla.

Os animo a que os registréis y mejoréis su contenido.

Dirección de la wiki: http://1984.lsi.us.es/wiki-latex


Documentando el código

04/17/2011

Me encuentro actualmente escribiendo comentarios con un formato especial en el código del proyecto para luego generar una documentación del código (no confundir con la Documentación del proyecto) en formato HTML u otros. Probablemente, cuando tenga la documentación del código terminada, la incorpore a la Documentación del proyecto.

La herramienta de generación de documentación de código que estoy usando es Epydoc.