一些不错的Sphinx定制示例？

Question

我使用 sphinx-quickstart 创建了一个Sphinx文档。

1. 有没有关于自定义外观的好例子/教程？特别是修改标题并添加徽标。

2. 是否有一些可下载Sphinx文档的项目？我想看看他们如何定制他们的外观。

更新：默认设置支持添加徽标，但没有特别详细记录。在conf.py中查看*_logo设置。

Answer 1

查看一些these themes。由于项目是开源的，您应该能够仔细检查它们。

Answer 2

开始收集链接的时间。

• https://github.com/coordt/ADCtheme - 类似Apple的
• https://github.com/mitsuhiko/flask-sphinx-themes - Flask
• http://loose-bits.com/2012/11/19/sphinx-bootstrap-theme-updates.html - Twitter Bootstrap
• https://github.com/snide/sphinx_rtd_theme - 阅读文档的主题
• https://github.com/bitprophet/alabaster - 基于Flask

Answer 3

我认为

Matplotlib documentation是一个很好的例子。他们甚至在documenting matplotlib处有详细说明：dynamically generated figures和inheritance diagrams是我认为他们对Sphinx的自定义扩展。他们的文档也有自定义徽标。

我猜你应该能够为大多数项目下载RST文档源。

Answer 4

http://docs.djangoproject.com/en/1.1/和http://ask.github.com/celery/是两个很好的例子。

Answer 5

我一直很喜欢SQLAlchemy文档。它们与标准的Sphinx主题看起来非常不同，非常适合他们的网站。

Answer 6

blender.org的新API文档刚刚进行了改造，sphinx主题也可以下载

网站
 http://www.blender.org/documentation/blender_python_api_2_59_release

主站点（主题基于此）
 http://www.blender.org/

主题文件
https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/

我知道的一个例子，但有趣的是看到比赛的接近程度。

Answer 7

转到http://pypi.python.org并在那里搜索sphinx template。它将列出几十个模板。然后他们每个人都可以下载并试试。

Answer 8

我非常喜欢Kenneth Reitz用于requests库的https://github.com/kennethreitz/kr-sphinx-themes主题：

{{3}}