Différences

Ci-dessous, les différences entre deux révisions de la page.

--- dev:python:sphinx:installation [2023/10/21 12:58] – yoann
+++ dev:python:sphinx:installation [2023/10/22 11:24] (Version actuelle) – yoann
@@ Ligne 25: / Ligne 25: @@
 Ici on fait le choix de séparer les répertoires source et build de la documentation.
-Pour plus de clarté, on fait le choix de renommer le répertoire ''source'' de la documentation en ''doc''. Il faudra ensuite modifier le makefile:
+Pour plus de clarté, on fait le choix de renommer les répertoires :
+  * ''source'' -> ''doc'' : Pour sphinx ''source'' contient les fichiers sources de la documentation mais dans un projet de code, cela peut porter à confusion.
+  * On crée un sous repertoire dans build pour la documentation.
+Il faudra ensuite modifier le fichier Makefile:
 <code bash>
@@ Ligne 44: / Ligne 48: @@
 </code>
+Tester une compilation
+<code bash>
+make html
+</code>
+===== Changer le thème =====
+Le thème "Read The Doc" a été téléchargé mais il n'est pas encore utilisé. Modifier le fichier de configuration ''**doc/conf.py**'' :
+<code python>
+...
+# Utilise le thème Read the Doc
+html_theme = 'sphinx_rtd_theme'
+</code>
+Les nombreuses [[https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html|options de configuration du thème]] son décrite dans la documentation officielle du thème.
+<note>
+Pour écrire la documentation dans une autre langue que l'anglais il faut activer l'extension ''sphinx_rtd_theme'' pour permettre la traduction des éléments de l'interface. Modifier le fichier conf.py
+</note>
+<code python>
+...
+extensions = [
+  'sphinx_rtd_theme',
+]
+</code>
 ===== Références =====

wikinotes

Outils pour utilisateurs

Outils du site

Différences

Outils de la page