Python文档首页

Question

http://docs.python.org/3/

我想模仿我自己项目的python文档fronpage。麻烦是除了头版以外，其他所有页面都在侧边栏中显示源链接。

如何在新的sphinx项目中存档相同的效果？

Answer 1

http://docs.python.org/3/的文档首页基于Jinja模板。

• 顶级模板为layout.html，其中Sphinx template的名称相同。
• indexcontent.html提供主要内容的结构。
• 侧边栏有自己的特殊模板：indexsidebar.html。

该主题名为pydoctheme（conf.py中的html_theme = 'pydoctheme'）。

有关Sphinx中模板和主题的更多信息：

• http://sphinx-doc.org/templating.html
• http://sphinx-doc.org/theming.html