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

Undefined hyper references #18

Open
humitos opened this issue Nov 5, 2022 · 4 comments
Open

Undefined hyper references #18

humitos opened this issue Nov 5, 2022 · 4 comments

Comments

@humitos
Copy link
Member

humitos commented Nov 5, 2022

Latex está reportando estos warnings sobre hipervínculos. Sin embargo, no endiendo porqué no están definidos.

LaTeX Warning: Hyper reference `tutorial/datastructures:tut-loopidioms' on page
 28 undefined on input line 1015.

Entiendo que esto no es un problema, principalmente porque el link funciona bien en el PDF:

Screenshot_2022-11-05_10-13-16

(https://github.com/python/cpython/blob/b3cafb60afeb2300002af9982d43703435b8302d/Doc/tutorial/controlflow.rst?plain=1#L135-L136)

Si no entiendo mal, esto lo muestra Latex en la primera pasada cuando todavía las referencias no fueron calculadas. Sin embargo, en la siguiente pasada no se vuelven a mostrar estos warnings.

@cacrespo
Copy link
Collaborator

cacrespo commented Nov 8, 2022

Ni me calentaría por los hipervínculos. De hecho, dado que el foco es la versión papel los quitaría todos para reducir margen de error ¿?

@humitos
Copy link
Member Author

humitos commented Nov 9, 2022

Sí. En realidad a mí no me molestan los hipervínculos. Lo que quise indicar en este issue es que "puede ser" que haya hipervínculos (referencias) a otros capítulos de la documentación que no no están en el tutorial y puede quedar raro de leer. Por ejemplo: "Mira el módulo toml en la referencia de módulos"

En ese caso, como no tenemos el módulo toml en nuestro tutorial, tendríamos que ver cómo se visualiza en el tutorial. Todavía no encontré ninguno de estos casos, pero lo quería dejar asentado en algún lado.

@cacrespo
Copy link
Collaborator

Ahh.. ahora entendí mejor.
De acuerdo en que en esos casos puntuales hay que intervenir el texto.

humitos added a commit that referenced this issue Nov 12, 2022
Hay referencias (`:ref:`) a capítulos/secciones que no están incluídos en el
tutorial. Por lo tanto, lo que hacemos en cambiar esas referencias a links a la
versión online.

De esa forma, el lector puede indagar en el contenido si desea leer más sobre el
tema mencionado en el tutorial (pero no includo en su versión impresa).

Esto se hace utilizando la extensión de Sphinx `intersphinx` y linkeado
directamente a la versión online. Para eso, simplemente se antepone `python:` en
la referencia deseada.

Related #18
@humitos
Copy link
Member Author

humitos commented Nov 12, 2022

Para estos casos decidimos convertir estas referencias inexistentes en links y poner la URL como nota al pié de página. Hay un ejemplo en #28

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

2 participants