2017-03-26 2 views
0

스핑크스를 사용하여 사용자 가이드를 작성 중입니다. 그러나 많은 수의 .rst 파일이 있으며, 모두가 index.rst과 함께 메인 폴더에있을 때 파일을 추적하는 것은 상당히 어려워집니다.스핑크스 용 .rst 파일 구성?

이렇게 폴더에 정리하고 싶습니다. 그러나 make html 명령을 실행하면 폴더 내의 모든 .rst 파일을 찾을 수 없다는 경고 메시지가 나타납니다.

.rst 파일을 어떻게 구성 할 수 있습니까?

+0

관련 항목 : http://stackoverflow.com/questions/10199233/can-sphinx-link-to-documents-that-are-not-located-in-directoriesies-below-the-root/17217041#17217041 –

답변

3

이것은 스핑크스 문서 섹션 TOC Tree에 언급되어 있습니다. 당신의 index.rst에서

toctree 지시어 사용

Project Awesome 
=============== 

Welcome to the Project Awesome docs. 

.. toctree:: 
    :glob: 
    :maxdepth: 2 

    docs/* 
    new_starter/* 
    subject_guides/* 

위의 사용 "글 로빙"를,하지만 당신은 자신의 이름을 사용하는 대신 글 로빙 파일을 명시 적으로 주문할 수 있습니다.

+0

그것을 시도했다. ''glob :''이 필요합니다. 나는 사이드 바가 제대로 올려지지 않는 문제가 아직도있다. – bluprince13

+0

당신은 무엇을 기대하고 관찰합니까? "제대로"무엇입니까? 테마 문제 일 수 있습니다. –

+0

''readthedocs'' 테마를 사용하고 있습니다. 사이드 바는 문서를 탐색 할 때 자체를 업데이트하지 않고 더 낮은 레벨을 표시하지 않았습니다. 그러나, 나는 픽스를 발견했다. 빌드 파일을 지우고'make html'을 다시 실행했다. 그것은 지금 일하고있다 :) – bluprince13

관련 문제