python sphinx - español - Algunos buenos ejemplos de personalización Sphinx?
sphinx python (8)
He creado un documento Sphinx usando sphinx-quickstart .
¿Hay buenos ejemplos / tutoriales sobre cómo personalizar el aspecto? Específicamente para modificar el encabezado y agregar un logo.
¿Hay algunos proyectos con documentos descargables de Sphinx? Me gustaría ver cómo han personalizado su look.
actualización: la configuración predeterminada admite la adición de un logotipo, pero no está particularmente bien documentada. Busque en conf.py la configuración de *_logo
Echa un vistazo a algunos de estos temas . Como los proyectos son de código abierto, deberías poder examinarlos de cerca.
Es hora de empezar a coleccionar enlaces.
- github.com/coordt/ADCtheme - como 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 - Tema de Leer los documentos
- https://github.com/bitprophet/alabaster - Basado en el matraz
La nueva API Docs de blender.org acaba de ser renovada. El tema de la esfinge también se puede descargar.
Sitio
http://www.blender.org/documentation/blender_python_api_2_59_release
Sitio principal (cuyo tema se basa)
http://www.blender.org/
Archivos de temas
https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/
Solo un ejemplo que conozco, pero interesante para ver qué tan cerca está el partido.
Siempre me han gustado los documentos de SQLAlchemy . Se ven muy diferentes de los temas estándar de Sphinx y encajan muy bien en su sitio.
Soy un gran fanático del tema de Kenneth Reitz que usa para la biblioteca de requests :
Vaya a http://pypi.python.org y busque la sphinx template allí. Le dará una lista de algunas decenas de plantillas. A continuación, cada uno de ellos puede descargar y probar.
http://docs.djangoproject.com/en/1.1/ y http://ask.github.com/celery/ son dos buenos ejemplos.
La documentación de matplotlib es un excelente ejemplo, creo. Incluso tienen una descripción detallada en la documentación de matplotlib : las figuras generadas dinámicamente y los diagramas de herencia son sus extensiones personalizadas para Sphinx, creo. Su documentación tiene un logotipo personalizado también.
Supongo que debería poder descargar la fuente de documentos RST para la mayoría de los proyectos.