2017-10-19 13 views
1

여러 파일에 부품/챕터 등이 포함 된 모듈 형식의 문서를 유지할 수 있음을 알게되었습니다. by using the include command.하나의 긴 페이지를 만들지 않고 스핑크스에서 파트/챕터 구조를 보존하는 방법은 무엇입니까?

이 접근법의 유일한 문제점은 포함 된 모든 파일을 하나의 큰 파일로 효과적으로 연결한다는 것인데, 이는 더 이상 Sphinx Read The Docs theme에 의해 별도의 페이지로 처리되지 않음을 의미합니다.

이의 결과로, 문서는 사용자가 아니라 탐색을위한 previous/next 버튼을 짧게 페이지보다 아래로 스크롤해야 할 매우 긴 페이지가 있습니다. 필자는 문서가 후자의 구조를 가지기를 바란다. 왜냐하면 훨씬 편안한 사용자 경험을 창출한다고 생각하기 때문이다.

단일, 긴 페이지를 만들지 않고 파트/챕터 구조를 유지하려면 어떻게해야합니까? 당신이 참조하는 이전 문제에 자신을 내놓고

+0

이것이 바로 'toctree'의 정의입니다. http://www.sphinx-doc.org/en/stable/markup/toctree.html – mzjn

+0

안녕하세요 @ mzjn, 귀하의 의견에 감사드립니다. 나는 toctree에 대한 문서를 읽었고 그것을 사용하는 법을 알았지 만 'toctree가 무엇을위한 것'이라고 말할 때 당신이 무엇을 의미하는지 알지 못한다. 당신은 완전한 대답으로 당신의 코멘트에 대해 자세히 설명 할 수 있습니까? – AZD

+0

문제가 무엇인지 이해가 안됩니다. toctree는 "하나의 긴 페이지를 만들지 않고 파트/챕터 구조를 보존"하는 데 사용할 수 있습니다. – mzjn

답변

0

, 나는이 이상 주어진 솔루션에 대해 경고한다 질문 자체

제대로 제목을 재현하지 않았다 귀하의 문서 ("일부 :-)에 대해 너무 왜냐하면 toctree 지시문은 포함 된 문서의 첫 번째 제목을 해당 문서의 "맨 위 제목"으로 간주하기 때문입니다. 다른 해결책은 주 파일에서 toctree 지시문을 사용하여

###### 
Part 1 
###### 

부분을 이동하는 것이 었습니다.

###### 
Part 1 
###### 

.. toctree:: 
    :maxdepth: 2 

    test1 
    test2 

경험을 통해이 사실을 알게되었습니다. 그래도 이것에 대한 적절한 참조를 찾을 수는 없습니다.