Wie kann ich eine andere reST-Datei in der Dokumentation verknüpfen/referenzieren?

Question

Ich habe einfach keine Ahnung, wie ich mit einem anderen Dokument in der ReST-Datei verknüpfen kann.

Ich möchte eine Datei mit dem Namen install.rst zu meinem Quickstart-Handbuch in einem Absatz verknüpfen. Ich weiß nicht, wie ich das erreichen kann.

Bitte können Sie auch auf eine große Ressource verweisen, von wo ich Syntax für Ruhe nachschlagen kann. Der Standard-Schnellstart ist ein wenig langweilig und beinhaltet keine tiefgreifende Diskussion über die Verwendung von Ruhe mit Sphinx.

Die doc in Frage: http://todx.rtfd.io

Answer 1

andere Dateien referecnce ich folgend in den conf.py enthalten hatte. Ich nahm den Code aus der Dokumentation von Kissen (PIL Gabel) here.

extensions = ['sphinx.ext.intersphinx'] 

Ich denke, dass die Inter-Sphinx-Erweiterung zu meiner Hilfe kam. Es wurde über die anderen Dokumentseiten verlinkt.

Answer 2

Um Links zwischen verschiedenen reStructuredText (.rst) -Dateien zu erstellen, können Sie das von sphinx bereitgestellte Inline-Markup verwenden. See the documentation unter der Überschrift Querverweise Dokumente

oben auf die Datei, die Sie sein Label definieren

.. _my-reference-label: 

dann können Sie diese Verknüpfung aus anderen Dokumenten

:doc:`my-reference-label`. 

ich nicht mit Ich glaube, dass Sie die Erweiterung intersphinx verwenden müssen, da es sich um Links zwischen verschiedenen Projekten handelt. Mit dieser Methode können Sie verschiedene .rst-Dateien mit ihren relativen Pfaden verknüpfen, wie oben im Dokumentationslink beschrieben.