Comment puis-je lier/référencer un autre fichier reST dans la documentation?
Je ne sais tout simplement pas comment je peux créer un lien vers un autre document du fichier reST.
Je souhaite lier un fichier nommé install.rst à mon guide de démarrage rapide dans un paragraphe. Je ne sais pas comment je peux y arriver.
Pouvez-vous également vous référer à une excellente ressource à partir de laquelle je peux rechercher la syntaxe pour rester au repos? Le démarrage rapide par défaut est un peu ennuyeux et n'implique pas une discussion en profondeur sur l'utilisation du reste avec sphinx.
Le document en question est: http://todx.rtfd.io
Pour créer des liens entre différents fichiers reStructuredText (.rst), vous pouvez utiliser le balisage en ligne fourni par sphinx. Voir la documentation sous la rubrique Documents de référence
en plus du fichier vous définissez son étiquette
.. _my-reference-label:
alors vous pouvez y accéder à partir d'autres documents en utilisant
:ref:`my-reference-label`.
Je ne crois pas que vous ayez besoin d'utiliser l'extension intersphinx, car c'est pour les liens entre différents projets. Avec cette méthode, vous pouvez relier différents fichiers .rst en utilisant leurs chemins relatifs, comme décrit dans le lien documentaion ci-dessus.
J'écris le lien vers un autre document en utilisant ceci:
:doc:`my document <../my_doc>`
../my_doc est le chemin d'accès à mon fichier my_doc.rst.
J'ai aussi une extension inter-sphinx dans mon fichier conf.py.
extensions = ['sphinx.ext.intersphinx']
En simplifiant la réponse de @ eme-eme, vous pouvez simplement faire:
:doc:`path/to/document`
Vous n'avez pas besoin de mettre le chemin entre <> et de fournir un texte à afficher. Dans ce cas, un en-tête de niveau supérieur du document référencé sera affiché sous forme de lien.
Vous n'avez pas besoin d'une extension inter-sphinx pour cela.