views:

712

answers:

5

I've created a Sphinx document using sphinx-quickstart.

  1. Are there any good examples/tutorials about customizing the look? Specifically to modify the header and add a logo.

  2. Are there some projects with downloadable Sphinx docs? I would like to see how they've customized their look.

update: Adding a logo is supported in the default setup, just not particularly well documented. Look in conf.py for the *_logo settings.`

+4  A: 

Have a look at some of these themes. As the projects are open source you should be able to examine them closely.

Vinay Sajip
+3  A: 

Matplotlib documentation is an excellent example I think. They even have a detailed description at documenting matplotlib: dynamically generated figures and inheritance diagrams are their custom extensions to Sphinx I think. Their documentation has a custom logo too.

I would guess that you should be able to download the RST document source for most projects.

Alok
+3  A: 

http://docs.djangoproject.com/en/1.1/ and http://ask.github.com/celery/ are two good examples.

Alex Gaynor
+2  A: 

I've always liked the SQLAlchemy docs. They look very different from the standard Sphinx themes and fit very well into their site.

Steven Wei
+1  A: 

blender.org's new API Docs just got a makeover the sphinx theme is downloadable too

Site http://www.blender.org/documentation/250PythonDoc/

Main Site (which theme is based off) http:// www.blender.org/

Theme files https:// svn.blender.org/svnroot/bf-blender/trunk/blender/source/blender/python/doc/blender-org/

Just one example I know, but interesting to see how close the match is.

(cant post more then one hyperlink, so last 2 are garbled)