Objectius d’aquesta guia#
El focus principal d’aquesta guia és donar només una visió general de la infraestructura relacionada amb Sphinx utilitzada a ArviZ i PyMC, sense explicar gaire directament.
Alguns exemples del que hauries o no d’esperar d’aquesta guia:
guies de sintaxi de MyST o de rST |
explicacions sobre per què MyST i rST són importants |
descripcions sobre quins rols i quines directrius existeixen |
explicacions sobre què són els rols i les directrius |
explicacions sobre com configurar les construccions de Sphinx |
explicacions breus de tots els termes en aquesta taula i al diagrama introductori |
tutorials sobre com utilitzar les extensions que sostenen la documentació d’ArviZ i de PyMC |
descripcions sobre quines extensions s’utilitzen en les documentacions d’ArviZ i de PyMC i per què |
La major part del contingut serà referència a altres pàgines de documentació per a sphinx i les seves extensions, la guia de sintaxi MyST… El valor d’aquesta guia és doble. Centralitza totes aquestes referències externes i enllaços a la documentació útil en un sol lloc i explica com es combinen tots els elements relacionats amb Sphinx per servir els objectius de documentació a ArviZ i PyMC.