Jak mogę połączyć/odwołać się do innego pliku REST w dokumentacji?

Question

Po prostu nie mam pojęcia, w jaki sposób można utworzyć łącze do innego dokumentu w pliku reST.

Chcę połączyć plik o nazwie install.rst do mojego przewodnika szybkiego startu w akapicie. Nie wiem, jak to osiągnąć.

Czy możesz również odwołać się do wspaniałego zasobu, z którego mogę wyszukać składnię do odpoczynku. Domyślny quickstart jest trochę nudny i nie wymaga głębokiej dyskusji o używaniu odpoczynku z Sfinksem.

Doc w pytaniu: http://todx.rtfd.io

Answer 1

Aby referecnce inne pliki musiałem zaliczyć w conf.py. Wziąłem kod z dokumentacji Pillow (fork PIL) here.

extensions = ['sphinx.ext.intersphinx'] 

Myślę, że rozszerzenie między sfinksami przyszło mi z pomocą. Jest połączony z innymi stronami dokumentu.

Answer 2

Aby utworzyć powiązania między różnymi plikami reStructuredText (.rst), możesz użyć wbudowanego znacznika dostarczonego przez sfinksa. See the documentation tytule odsyłania dokumentów

na początku pliku można zdefiniować jego etykietę

.. _my-reference-label: 

następnie można połączyć się z nią z innymi dokumentami przy użyciu

:doc:`my-reference-label`. 

nie wiem uważamy, że musisz użyć rozszerzenia intersphinx, ponieważ jest ono przeznaczone dla łączy między różnymi projektami. Dzięki tej metodzie możesz łączyć różne pliki .rst, używając ich względnych ścieżek, jak opisano powyżej w odnośniku documentaion.