Ce thème Sphinx a été conçu pour offrir une excellente expérience de lecture aux utilisateurs de documentation sur les appareils de bureau et mobiles. Ce thème est principalement utilisé sur Read the Docs mais peut fonctionner avec n'importe quel projet Sphinx. Vous pouvez trouver une démo fonctionnelle du thème dans la documentation du thème
Ce thème est distribué sur PyPI et peut être installé avec pip
:
$ pip installe le thème sphinx-rtd
Pour utiliser le thème dans votre projet Sphinx, vous devrez modifier le paramètre html_theme
de votre fichier conf.py
:
html_theme = "sphinx_rtd_theme"
Voir aussi :
Navigateurs pris en charge
Combinaisons navigateur/système d'exploitation officiellement prises en charge et testées
Dépendances prises en charge
Versions prises en charge de Python, Sphinx et autres dépendances.
Exemple de documentation
Un exemple complet de cette sortie de thème, avec les chaînes localisées activées.
Ce thème est hautement personnalisable à la fois au niveau de la page et au niveau global. Pour voir toutes les options de configuration possibles, lisez la documentation sur la configuration du thème.
Si vous souhaitez contribuer à modifier ou traduire le thème, vous trouverez plus d'informations sur la contribution dans notre guide de contribution.