18

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

  1. 有没有关于自定义外观的好例子/教程?专门修改表头,加个logo。

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

更新:默认设置支持添加徽标,只是没有特别好的文档记录。查看conf.py设置*_logo

4

8 回答 8

11

看看其中一些主题。由于这些项目是开源的,您应该能够仔细检查它们。

于 2010-01-16T00:50:31.783 回答
10

是时候开始收集链接了。

于 2012-12-07T11:46:35.373 回答
7

我认为Matplotlib 文档是一个很好的例子。他们甚至在记录 matplotlib时有详细的描述:我认为动态生成的图形继承图是他们对 Sphinx 的自定义扩展。他们的文档也有一个自定义徽标。

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

于 2010-01-16T01:20:32.623 回答
5

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

于 2010-01-16T01:41:51.583 回答
4

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

于 2010-01-16T06:27:55.847 回答
4

blender.org 的新 API 文档刚刚改头换面,狮身人面像主题也可下载

网站
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/

我知道的只是一个例子,但有趣的是看看比赛有多接近。

于 2010-05-15T07:50:44.160 回答
3

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

于 2013-01-23T14:22:04.257 回答
0

我是Kenneth Reitz用于requests库的主题的忠实粉丝:

https://github.com/kennethreitz/kr-sphinx-themes

于 2014-02-27T17:07:53.427 回答