Einige gute Sphinx-Anpassungsbeispiele?

Question

Ich habe ein Sphinx-Dokument mit sphinx-quickstart erstellt.

1. Gibt es gute Beispiele/Tutorials zum Anpassen des Aussehens? Speziell um den Header zu ändern und ein Logo hinzuzufügen.

2. Gibt es einige Projekte mit herunterladbaren Sphinx-Dokumenten? Ich würde gerne sehen, wie sie ihr Aussehen angepasst haben.

Update: ein Logo Hinzufügen wird in der Standardkonfiguration unterstützt, nur nicht besonders gut dokumentiert. Suchen Sie in conf.py für die *_logo Einstellungen.

Answer 1

Werfen Sie einen Blick auf einige der these themes. Da die Projekte Open Source sind, sollten Sie in der Lage sein, sie genau zu untersuchen.

Answer 2

Matplotlib documentation ist ein hervorragendes Beispiel, denke ich. Sie haben sogar eine detaillierte Beschreibung unter documenting matplotlib: dynamically generated figures und inheritance diagrams sind ihre benutzerdefinierten Erweiterungen für Sphinx denke ich. Ihre Dokumentation hat auch ein benutzerdefiniertes Logo.

Ich würde vermuten, dass Sie in der Lage sein sollten, die RST-Dokumentquelle für die meisten Projekte herunterzuladen.

Answer 3

http://docs.djangoproject.com/en/1.1/ und http://ask.github.com/celery/ sind zwei gute Beispiele.

Answer 4

Ich habe immer die SQLAlchemy Docs gefallen. Sie sehen ganz anders aus als die Standard-Sphinx-Themen und passen sehr gut in ihre Site.

Answer 5

neue API-Dokumentation des blender.org bekam nur ein neues Gesicht der Sphinx Thema herunterladbare ist zu

Website
http://www.blender.org/documentation/blender_python_api_2_59_release

Main Site (das Thema basiert weg ist)
Dateien http://www.blender.org/

Theme
https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/

Nur ein Beispiel, das ich kenne, aber interessant zu sehen, wie nah das Spiel ist.

Answer 6

Zeit zum Sammeln von Links.

• https://github.com/coordt/ADCtheme - Apple wie
• 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 - Thema von Lesen Sie den Text & Tabellen
• https://github.com/bitprophet/alabaster - Basierend auf der Flasche

Answer 7

Go an die http://pypi.python.org und suchen Sie dort nach sphinx template. Es wird eine Liste von einigen Dutzend Vorlagen geben. Dann kann jeder von ihnen herunterladen und ausprobieren.

Answer 8

Ich bin ein großer Fan von Kenneth Reitz ‚s Thema, das er für die requests Bibliothek verwendet:

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