Cet article concerne le module Python "Sphinx"
--Comment installer --Comment créer un projet --Comment changer le thème standard --Comment changer le thème externe (Bootswatch)
Je vais vous expliquer.
Veuillez consulter le site suivant pour des explications détaillées sur Sphinx. Association des utilisateurs de Sphinx Japon
Cette fois, j'ai créé et installé un environnement virtuel, Cette étape n'est pas nécessaire à moins que vous n'utilisiez votre propre module d'environnement virtuel ou que vous ne soyez particulier à ce sujet.
Créez un environnement virtuel à n'importe quel endroit et démarrez-le.
$ mkdir Sphinx
$ virtualenv --no-site-packages Sphinx
$ cd Sphinx
$ source bin/activate
(Sphinx)$
Ensuite, installez le module Sphinx à l'aide de pip.
(Sphinx)$ pip install sphinx
À ce stade, l'installation de Sphinx est terminée.
Créez un dossier dédié au projet à n'importe quel endroit et Exécutez la commande sphinx-quickstart.
(Sphinx)$ mkdir MyProject
(Sphinx)$ cd MyProject
(Sphinx)$ sphinx-quickstart
Lorsque j'exécute la commande, je suis interrogé sur toutes les options, mais si j'appuie sur la touche Entrée de base, tout va bien,
Seuls trois éléments doivent être saisis, alors saisissez-les correctement. Il existe un paramètre de langue pour l'élément, mais si vous souhaitez utiliser le japonais, entrez ja pour continuer.
Une fois la création du projet terminée
(Sphinx)$ make html
Générera du HTML dans _build / html dans le répertoire courant. Si vous affichez _build / html / index.html dans votre navigateur, vous pouvez voir que le document a été généré.
Les paramètres liés au changement de thème se trouvent dans le dossier du projet (MyProject cette fois) Faites-le dans conf.py.
conf.py
html_theme = 'default'
Vous pouvez modifier le thème standard en modifiant la partie chaîne de caractères de.
N'oubliez pas après le changement
(Sphinx)$ make html
Faisons.
Il existe neuf thèmes standard comme suit.
Les images de thème standard qui peuvent être utilisées sont publiées sur le site suivant. Collection de thèmes standard
Sphinx vous permet également d'utiliser des thèmes externes. Cette fois, je vais vous expliquer en utilisant le thème Bootswatch. Bootswatch
・ Installation de Bootswatch Continuez à travailler dans l'environnement virtuel.
(Sphinx)$ pip install shpinx_bootstrap_theme
-Réglage du thème Bootswatch sur Sphinx Ceci est également défini dans conf.py dans le dossier du projet.
Tout d'abord, importez le module dans la première ligne de conf.py. Veuillez faire attention à ne pas commenter.
conf.py
import sphinx_bootstrap_theme
Continuez vers le répertoire où le thème est enregistré Et définissez le nom du thème.
conf.py
html_theme = 'bootstrap'
html_theme_path = ['../lib/python3.5/site-packages/sphinx_bootstrap_theme']
~~ La documentation officielle de Bootwatch a déclaré qu'une fonction dédiée a été préparée pour définir html_theme_path, mais comme une erreur s'est produite dans mon environnement, elle est décrite comme un chemin relatif vers le module ~~
** Addendum: signalé par yuntas ** Il semble être résolu en décommentant ce qui suit dans conf.py.
conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
...
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
Spécifiez ensuite le thème Bootwatch à utiliser, juste en dessous du code ci-dessus. Cliquez ici pour les types de thèmes. Bootswatch
conf.py
html_theme_options = {'bootswatch_theme': "cosmo"}
N'oubliez pas cela après le changement
(Sphinx)$ make html
Faisons.
Ceci termine la configuration du thème externe.
Recommended Posts