2014-01-05 2 views
9

멋진 sphinx-bootstrap-theme 0.3.4를 사용하고 Sphinx Python Documentation Generator 버전 1.2에 적용하려고합니다.sphinx-bootstrap-theme에 기반한 Python-Sphinx 문서의 사이드 바 활성화

make html을 통해 설명서를 만들 때이 사이드 바를 얻을 수는 없지만 example에서 가능합니다. 어느 쪽도 아니요, 빌드 구성 파일 (conf.py)에서 사이드 바를 활성화하는 옵션을 찾을 수 없었습니다. 다음을 수행 :

html_sidebars = {'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html']} 

도움이되지 않습니다.

스핑크스 테마에서 사이드 바를 사용하는 것이 가능하다는 힌트를 주셔서 감사합니다.

답변

13

그냥 알아 냈습니다. 이것은 트릭을해야합니다.

html_sidebars = {'**': ['localtoc.html', 'sourcelink.html', 'searchbox.html']} 

내가 포함 된 옵션을 좋아하지 않기 때문에 사용자 정의 사이드를 만드는 실험을하고 참조

Sphinx theming guide html_sidebars

으로이 사용. 부트 스트랩 데모 index.html을 사용하여 사용자 정의 사이드 바에 다음을 작성했습니다. 그냥 그것을 my_custom_sidebar.html 같은 이름을 지정하고에/소스를 넣어 /가`theme_globaltoc_depth`에 대한 오류를 던지고있다 html_sidebars

html_sidebars = {'**': ['my_custom_sidebar.html', 'searchbox.html']} 
+0

<ul class="globaltoc" >{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }}</ul> 

그런 다음 편집 _templates. 경우에 따라 제거하십시오. –