Este tema de Sphinx fue diseñado para brindar una excelente experiencia de lectura a los usuarios de documentación tanto en dispositivos móviles como de escritorio. Este tema se utiliza principalmente en Read the Docs, pero puede funcionar con cualquier proyecto de Sphinx. Puede encontrar una demostración funcional del tema en la documentación del tema.
Este tema se distribuye en PyPI y se puede instalar con pip
:
$ pip instalar tema-rtd-esfinge
Para usar el tema en su proyecto Sphinx, necesitará editar la configuración html_theme
de su archivo conf.py
:
html_theme = "esfinge_rtd_theme"
Ver también:
Navegadores compatibles
Combinaciones de navegador/sistema operativo oficialmente soportadas y probadas
Dependencias admitidas
Versiones compatibles de Python, Sphinx y otras dependencias.
Documentación de ejemplo
Un ejemplo completo de la salida de este tema, con cadenas localizadas habilitadas.
Este tema es altamente personalizable tanto a nivel de página como a nivel global. Para ver todas las opciones de configuración posibles, lea la documentación sobre cómo configurar el tema.
Si desea ayudar a modificar o traducir el tema, encontrará más información sobre cómo contribuir en nuestra guía de contribución.