[PYTHON] Lorsque vous souhaitez que le thème de votre documentation Sphinx soit le même

introduction

Le thème par défaut de Sphinx est très élégant et quelque chose de différent.

Après tout, je veux utiliser l'habituel.

La chose habituelle

https://github.com/readthedocs/sphinx_rtd_theme

スクリーンショット 2019-11-14 13.12.54.png

C'est un élément très fréquemment utilisé.

Apparemment, il s'agit d'un thème tiers, pas d'un thème officiel, vous devrez donc l'installer séparément.

procédure

Avec un pip Python appliqué au répertoire dans lequel vous souhaitez utiliser le thème

$ pip install sphinx-rtd-theme

Faire.

Puis dans le fichier de configuration conf.py

conf.py


extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.todo',
    'sphinx.ext.napoleon',
    'sphinx_rtd_theme'
]
html_theme = 'sphinx_rtd_theme'

Ajoutez simplement des extensions et html_theme.

Site thématique

Parce que sphinx-themes a une liste de thèmes disponibles Il semble bon de l'utiliser.

Recommended Posts

Lorsque vous souhaitez que le thème de votre documentation Sphinx soit le même
Lorsque vous souhaitez mettre à jour le pilote Chrome.
Lorsque vous souhaitez ajuster l'intervalle de l'échelle de l'axe avec APLpy
Lorsque vous souhaitez l'utiliser tel quel lorsque vous l'utilisez avec lambda memo
Remarque Python: lorsque vous souhaitez connaître les attributs d'un objet
Lorsque vous souhaitez modifier l'en-tête HTTP du client de test de Flask
Linux: guide de configuration Netplan pour savoir quand vous souhaitez corriger l'adresse IP
Paramètres lorsque vous souhaitez exécuter python-mecab avec travis
Lorsque vous souhaitez filtrer avec le framework Django REST
Lorsque la variable que vous souhaitez utiliser comme exposant dans matplotlib comporte deux caractères ou plus
Lorsque vous voulez plt.save dans l'instruction for
Le langage de programmation que vous souhaitez pouvoir utiliser
Lorsque vous souhaitez traduire rapidement un exemple C # dans un autre langage tel que VB
[Python] Lorsque vous souhaitez importer et utiliser votre propre package dans le répertoire supérieur
[Django] Mémorandum lorsque vous souhaitez communiquer de manière asynchrone [Python3]
[AWS] Que faire lorsque vous souhaitez piper avec Lambda
Je voulais ignorer certaines extensions lors de la création de la documentation Sphinx
Utilisez aggdraw lorsque vous voulez dessiner magnifiquement avec un oreiller
Lorsque vous souhaitez enregistrer les données initiales de Django avec des relations
Lorsque vous souhaitez utiliser python 2.x sur Gentoo Linux moderne
Si vous souhaitez que vos collègues utilisent la même langue
Lorsque vous souhaitez lancer une commande UNIX sur Python
(Mémo) Jusqu'à ce que vous extrayiez uniquement la partie que vous voulez d'une certaine page Web, convertissez-la en page Sphinx et imprimez-la au format PDF
Lorsque vous souhaitez utiliser plusieurs versions de la même bibliothèque Python (environnement virtuel utilisant venv)
[Sous-processus] Lorsque vous souhaitez exécuter un autre programme Python en code Python
Je souhaite enregistrer l'heure d'exécution et conserver un journal.
[Linux] Je souhaite connaître la date à laquelle l'utilisateur s'est connecté
Je veux exécuter l'interface graphique Python au démarrage de Raspberry Pi
[Python] Lorsque vous souhaitez utiliser toutes les variables dans un autre fichier
Lorsque vous souhaitez envoyer un objet avec des requêtes à l'aide de flask
Que faire lorsque vous obtenez "Je ne peux pas voir le site !!!!"
Lorsque vous souhaitez trier une liste multidimensionnelle sur plusieurs lignes
Mémorandum Expression régulière Lorsqu'il y a plusieurs caractères que vous souhaitez séparer dans la chaîne de caractères
Étape Wercker pour compiler la documentation Sphinx
Essayez d'introduire le thème sur Pelican
Opérations clés que vous souhaitez connaître
Si vous voulez un singleton en python, considérez le module comme un singleton
Un référentiel essentiel à utiliser lorsque vous souhaitez l'essayer avec ansible
Lorsque vous souhaitez remplacer une colonne par une valeur manquante (NaN) colonne par colonne
Lors de l'introduction de l'API Google Cloud Vision sur les rails, j'ai suivi la documentation.
Wrapper lorsque vous souhaitez afficher la couleur utf-8 + ansi dans la console Windows
Qt n'est-il pas la bibliothèque la plus puissante pour une sortie facile de SVG?
Signifie mémo lorsque vous essayez de faire de l'apprentissage automatique avec 50 images
[Python3] Code qui peut être utilisé lorsque vous souhaitez modifier l'extension d'une image à la fois
Installez la bibliothèque python lorsque vous n'êtes pas un sudoer (ou si vous ne voulez pas que les nouveaux utilisateurs soient Sudoer, mais cela ne vous dérange pas d'avoir la bibliothèque Python incluse)