2016-05-31 4 views
5

나는 reST 파일의 다른 문서에 어떻게 링크시킬 수 있을지 전혀 모른다.설명서에 다른 reST 파일을 연결하거나 참조하려면 어떻게합니까?

install.rst이라는 파일을 단락의 빠른 시작 가이드에 연결하고 싶습니다. 나는 어떻게이 일을 성취 할 수 있는지 모른다.

휴식을 위해 구문을 찾을 수있는 훌륭한 리소스를 참조하십시오. 기본 빠른 시작은 약간 지루하며 스핑크스와 함께 휴식을 사용하는 것에 대한 깊이있는 토론이 필요하지 않습니다.

문제의 문서는 다음과 같습니다 http://todx.rtfd.io

+0

http://www.sphinx-doc.org/en/stable/markup/inline.html#ref-role – mzjn

+0

@mzjn 그래서 마커를 두 번째 파일 인'install.rst '? –

답변

0

나는이 (가) conf.py에 다음을 포함했다 다른 파일을 referecnce하십시오. 필로우 (PIL 포크) here의 문서에서 코드를 가져 왔습니다.

extensions = ['sphinx.ext.intersphinx'] 

스핑크스 간의 확장이 도움이되었다고 생각합니다. 그것은 다른 문서 페이지에 링크되어 있습니다.

+8

다른 문서에 대한 링크를 작성하는 방법에 대해서도 설명해주십시오. –

5

다른 reStructuredText (.rst) 파일간에 링크를 만들려면 sphinx에서 제공하는 인라인 마크 업을 사용할 수 있습니다. 당신이

:doc:`my-reference-label`. 

내가 안 사용 후

.. _my-reference-label: 

다른 문서에서 링크 할 수 있습니다 라벨을 정의 파일의 상단에

제목 상호 참조 문서에서 See the documentation 다른 프로젝트 사이의 링크이기 때문에 당신이 intersphinx 확장을 사용해야한다고 생각합니다. 이 방법을 사용하면 위의 문서 링크에 설명 된대로 상대 경로를 사용하여 여러 .rst 파일을 연결할 수 있습니다.