'Some good Sphinx customization examples? [closed]
I've created a Sphinx document using sphinx-quickstart.
Are there any good examples/tutorials about customizing the look? Specifically to modify the header and add a logo.
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.`
Solution 1:[1]
Time to start collecting links.
- https://github.com/coordt/ADCtheme - Apple-like
- 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 - Theme of Read the Docs
- https://github.com/bitprophet/alabaster - Based on the Flask
- https://gitlab.com/documatt/sphinx-themes - themes collection for tech writing
Solution 2:[2]
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.
Solution 3:[3]
http://docs.djangoproject.com/en/1.1/ and http://ask.github.com/celery/ are two good examples.
Solution 4:[4]
I've always liked the SQLAlchemy docs. They look very different from the standard Sphinx themes and fit very well into their site.
Solution 5:[5]
blender.org's new API Docs just got a makeover the sphinx theme is downloadable too
Site
http://www.blender.org/documentation/blender_python_api_2_59_release
Main Site (which theme is based off)
http://www.blender.org/
Theme files
https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/
Just one example I know, but interesting to see how close the match is.
Solution 6:[6]
Go to the http://pypi.python.org and search for sphinx template there. It will give a list of some tens of templates. Then each of them You can download and try.
Solution 7:[7]
I'm a big fan of Kenneth Reitz's theme he uses for the requests library:
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
| Solution | Source |
|---|---|
| Solution 1 | |
| Solution 2 | Ken Williams |
| Solution 3 | Alex Gaynor |
| Solution 4 | stevesw |
| Solution 5 | |
| Solution 6 | Adobe |
| Solution 7 | danriti |