Come posso collegare/fare riferimento a un altro file di ripristino nella documentazione?

Question

Non ho semplicemente idea di come posso collegarmi a un altro documento nel file di ripristino.

Desidero collegare un file denominato install.rst alla mia guida rapida in un paragrafo. Non so come posso ottenere questo.

Si può anche fare riferimento a una grande risorsa da cui posso cercare la sintassi per il riposo. L'avvio rapido predefinito è un po 'noioso e non implica una discussione approfondita sull'uso del riposo con la sfinge.

Il documento in questione è: http://todx.rtfd.io

Answer 1

Per referecnce altri file ho dovuto includere quanto segue nella conf.py. Ho preso il codice dai documenti di Pillow (PIL fork) here.

extensions = ['sphinx.ext.intersphinx'] 

Penso che l'estensione inter-sfinge mi sia venuta in aiuto. È collegato tra le altre pagine del documento.

Answer 2

Per creare collegamenti tra diversi file reStructuredText (.rst) è possibile utilizzare il markup in linea fornito dalla sfinge. See the documentation sotto il titolo documenti riferimenti incrociati

sulla parte superiore del file che si definiscono la sua etichetta

.. _my-reference-label: 

allora si può collegare ad esso da altri documenti utilizzando

:doc:`my-reference-label`. 

non lo faccio credi di aver bisogno di usare l'estensione intersphinx, dato che è per i collegamenti tra diversi progetti. Con questo metodo puoi collegare tra diversi file .rst usando i loro percorsi relativi come descritto nel link documentaion sopra.