Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rst2pdf warning de estilo indefinido y error en la interpretación de docstrings de python #1204

Open
TigerClawKnight opened this issue Apr 9, 2024 · 0 comments

Comments

@TigerClawKnight
Copy link

Buenos días, compañeros.

Nota: En la investigación realizada no he encontrado algo referente a si rst2pdf puede generar documentación de código python por medio de los docstrings.

Solicitando de su ayuda y asesoría para resolver lo siguiente que les compartó.

Parte 1: Warning styles.py Using undefined style 'function', aliased to style 'normal'.
Este detalle sale al utilizar rst2pdf bajo el caso:
1.- Cuando se ejecuta el comando rst2pdf archivo.rst archivo.pdf
Dentro del rst tengo lo siguiente:
Ejemplo 1
--------------
.. include:: prueba.py
:code: python

En el archivo.py:
def primer_hola_mundo():
"""Una función de prueba para
Para utilizar rst2pdf.
"""
print("Buen día, hola mundo")

2.- Caso contrario, cuando se ejecuta el comando rst2pdf archivo.py archivo.pdf no marca este detalle.

Nota: Esto lo veo por que son archivos de prueba pero en códigos más grandes marca el error del estilo.

Se le pasa una hoja de estilo que se tiene creada pero aún así sigue marcando errores de estilos, pienso que es por que está interpretando el nombre de la función como un estilo pero es código, no debería considerarlo como estilo.

Parte 2: Docstrings de código python

En el archivo.py tengo el código documentado con el formato de Google, al querer generar el pdf para obtener la documentación de los comentarios del código del archivo.py, marca errores de indentación pero no dentro de los comentarios sino del código mismo. Se ha revisado de forma exhaustiva los espacios y todo está bien.
Al ejecutar el comando rst2pdf archivo.py archivo.pdf muestra lo siguiente:
(ERROR/3)Unexpected indentation.
(ERROR/3)Unexpected indentation.
(ERROR/3)Unexpected indentation.
(WARNING/2) Block quote ends without a blank line; unexpected unindent.

Nota: Esas líneas que marcan error de indentación puede ser que rst2pdf esté intentando interpretarlo por que en el pdf esas líneas la primera tiene un enfásis más fuerte (bold) y el resto texto normal.
error

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant