Documentación de pilas en PDF

[hugoruscitti]

Saludos, mientras escribo pilas estoy redactando la documentación
completa del proyecto:

http://bitbucket.org/hugoruscitti/pilas ... engine.pdf

estoy probando una metodologia de desarrollo que sugiere mantener
juntas la documentacion, los test y la codificacion, así cada cambio en la biblioteca
no queda sin documentar y se puede liberar y usar lo antes
posible.

Saludos.

[adrigm77]

Me parece bien, ¿Con qué estás desarrollando la documentación? A lo mejor sería bueno tener un wiki de discusión sobre cosas implementadas, objetivos y demás.

Otra cosa es que veo que usas pySFML para cargar imágenes, osea que ¿Dependerá de esta biblioteca?

Me gustaría ayudar pero no tengo nada claro los objetivos a lograr y en que habría que trabajar.

[carlostex]

Me parece bien, ¿Con qué estás desarrollando la documentación? A lo mejor sería bueno tener un wiki de discusión sobre cosas implementadas, objetivos y demás.

Otra cosa es que veo que usas pySFML para cargar imágenes, osea que ¿Dependerá de esta biblioteca?

Me gustaría ayudar pero no tengo nada claro los objetivos a lograr y en que habría que trabajar.

Siempre se habló de usar una biblioteca para manejar la parte gráfica, no se pensaba hacer parte del motor, eso seria mucho mas trabajo, y para que, si ya esta hecho, para eso estan las bibliotecas para usarse.

[hugoruscitti]

Me parece bien, ¿Con qué estás desarrollando la documentación? A lo mejor sería bueno tener un wiki de discusión sobre cosas implementadas, objetivos y demás.

Estoy usando sphinx [0], que actualmente es bastante popular entre los
programadores de python, de hecho el mismo lenguaje se está documentando
usando esa herramienta.

Si ingresas en el directorio "doc" del proyecto vas a encontrar toda
la documentación ahí. Simplemente escribo en archivos de texto y
sphinx genera toda la documentación en PDF o HTML (entre otros).

Sobre las sugerencias, creo que el foro está bueno para eso, ¿se te
ocurrió algo en particular?.


0 - http://sphinx.pocoo.org/

[Geo]

Tengo problemas para construir la documentación, al ejecutar "make pdf" en el directorio doc, obtengo esto:

Running Sphinx v0.6.4
WARNING: the config value '__file__' is set to a string with non-ASCII characters; this can lead to Unicode errors occurring. Please use Unicode strings, e.g. u"Content".
loading pickled environment... not found
building [html]: targets for 12 source files that are out of date
updating environment: 12 added, 0 changed, 0 removed
reading sources... [ 25%] empezando
Exception occurred:
File "/usr/lib/python2.6/posixpath.py", line 70, in join
path += '/' + b
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 16: ordinal not in range(128)
The full traceback has been saved in /tmp/sphinx-err-8kvrYy.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

El contenido del traceback es:

# Sphinx version: 0.6.4
# Docutils version: 0.6 release
Traceback (most recent call last):
File "/usr/lib/pymodules/python2.6/sphinx/cmdline.py", line 170, in main
app.build(all_files, filenames)
File "/usr/lib/pymodules/python2.6/sphinx/application.py", line 131, in build
self.builder.build_update()
File "/usr/lib/pymodules/python2.6/sphinx/builders/__init__.py", line 265, in build_update
'out of date' % len(to_build))
File "/usr/lib/pymodules/python2.6/sphinx/builders/__init__.py", line 285, in build
purple, length):
File "/usr/lib/pymodules/python2.6/sphinx/builders/__init__.py", line 131, in status_iterator
for item in iterable:
File "/usr/lib/pymodules/python2.6/sphinx/environment.py", line 513, in update_generator
self.read_doc(docname, app=app)
File "/usr/lib/pymodules/python2.6/sphinx/environment.py", line 610, in read_doc
self.process_images(docname, doctree)
File "/usr/lib/pymodules/python2.6/sphinx/environment.py", line 751, in process_images
if not os.access(path.join(self.srcdir, imgpath), os.R_OK):
File "/usr/lib/python2.6/posixpath.py", line 70, in join
path += '/' + b
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 16: ordinal not in range(128)

Supongo que tiene que ver con la codificación de los archivos, ¿alguien tendrá alguna idea?

Gracias.

[hugoruscitti]

Running Sphinx v0.6.4
WARNING: the config value '__file__' is set to a string with non-ASCII characters; this can lead to ...

Me parece un poco desactualizada la versión de sphinx... prueba
instalando una versión mas nueva a ver si ocurre lo mismo. Creo
que la versión actual es la 1.0.2