Rols#
Els rols són per a contingut en línia, i s’utilitzen principalment per a format i per a referències encreuada. Els rols requereixen un tipus i un argument. Opcionalment, quan s’utilitza només com a referència encreuada, els rols també poden contenir un text personalitzat per a l’enllaç. També opcionalment, alguns rols de formatació accepten opcions de formatació addicionals a més de l’argument principal, però, no hi ha cap regla general sobre això, alguns utilitzen parèntesis, altres semi-dos o comes…
Rols de formatació per abreviacions i fórmules matemàtiques: LPP, \(\exp{x}\)
Referències encreuades amb rols: Llenguatge de marques, torna a llenguatge de marques,
numpy.array()
* Formatting role for abbreviations and math:
{abbr}`PPL (Probabilistic Programming Language)`, {math}`\exp{x}`
* Cross-referencing roles:
{doc}`markup`, {doc}`back to markup <markup>`, {func}`numpy.array`
* A formatting role for abbreviations: :abbr:`PPL (Probabilistic Programming Language)`
* A cross-referencing role:
:doc:`markup`, :doc:`back to markup <markup>`, :func:`numpy.array`
Truc
Les referències encreuades de Sphinx són molt més potents i agradables per a persones que llegeixen documents sense renderitzar que els enllaços html. Probablement no hauríeu d’utilitzar enllaços html llevat que tingueu una bona raó per fer-ho (és a dir un sol enllaç extern), i sempre haurieu d’utilitzar referències encreuades de Sphinx per a enllaços interns.
Per més informació sobre referències encreuades de Sphinx visiteu la pàgina Cross-referencing in sphinx.
Recursos
documentació de Sphinx sobre rols