--Comment installer python3 et pip
--Installation du système python3
Créez un répertoire d'environnement virtuel pour Sphinx. Le nom du répertoire est arbitraire
$ mkdir sphinx
Accédez au répertoire que vous avez créé et créez un environnement virtuel Le nom de l'environnement virtuel est sphinx-venv ici.
$ cd sphinx
# 「python3 -Vous pouvez créer un environnement virtuel en utilisant "m venv virtual environment name".
$ python3 -m venv sphinx-venv
$ cd sphinx-venv
$ source bin/acitvate
$ pip install sphinx
Lorsque vous appuyez sur sphinx-quickstart, vous entendrez un message slurping et il vous sera demandé quelques-uns de manière interactive. Si vous n'êtes pas particulier à ce sujet pour le moment, vous pouvez le définir comme suit.
$ sphinx-quickstart
>Répertoire source séparé et répertoire de construction (y/ n） [n]:y
>Nom du projet: test-project
>Nom (s) de l'auteur: test-author
>Sortie du projet[]: 1.0.0
>Langue du projet[en]: ja
Dans mon environnement d'exécution, on m'a demandé en japonais comme ci-dessus, Selon l'environnement, il vous sera demandé en anglais comme suit.
$ sphinx-quickstart
> Separate source and build directories (y/N) [n]:y
> Project name: test-project
> Author name(s): test-author
> Project version []: 1.0.0
> Project language [en]: ja
Tout d'abord, générez un fichier html dans l'état par défaut. Pour générer un fichier html, tapez la commande suivante où se trouve le Makefile
$ make html
Cela générera un fichier appelé index.html sous le répertoire de construction. Veuillez l'afficher avec n'importe quel navigateur.
Dans Sphinx, pour ajouter du contenu,
--Créez un nouveau fichier et
est nécessaire.
Créez un fichier avec un nom approprié sous "source". Ici, le nom du fichier est "test.rst".
Écrivez le contenu de manière appropriée.
test.rst
===================
Mettez le titre ici
===================
Mettez un gros titre
---------------
-C'est une balle
-C'est une balle
"Index.rst" sous "source" est la première page. Editez ce fichier et enregistrez le "test.rst" créé précédemment. Pour l'édition, ajoutez le même nom que le nom de fichier comme indiqué ci-dessous.
index.rst (avant l'édition)
.. toctree::
:maxdepth: 2
:caption: Contents:
index.rst (après édition)
.. toctree::
:maxdepth: 2
:caption: Contents:
test
Maintenant, si vous exécutez à nouveau "make html", vous verrez la première page. "Mettre un titre ici" sera affiché avec un lien. Cliquez sur ce lien pour voir ce qui est dans test.rst.
Dans Sphinx, vous devez généralement éditer le document puis taper "make html" pour recharger le navigateur. C'est fastidieux, donc lorsque vous éditez le document, il générera automatiquement un fichier html afin qu'il soit rechargé automatiquement.
$ pip install sphinx-autobuild
Après l'installation, tapez la commande suivante dans le répertoire où se trouve "Makefile".
# sphinx-autobuild [xxx.Annuaire avec rst] [Répertoire dans lequel les fichiers html sont générés]
#Dans cette entrée, ce sera comme suit
$ sphinx-autobuild source build
Ensuite, le serveur démarrera localement, donc si vous affichez l'URL (http : // localhost: 8080) sur votre navigateur, vous pouvez afficher le fichier html créé.
Il y a la description suivante au bas de "conf.py" sous le répertoire "source".
conf.py
html_theme = 'alabaster'
Vous pouvez changer le thème en réécrivant «albâtre». Notez que «albâtre» est le thème par défaut.
Les thèmes standard suivants sont disponibles dans Sphix.
Vous pouvez également définir un thème tiers. Par exemple, si vous souhaitez définir un thème de conception de matériau, installez le thème comme suit.
$ pip install sphinx-theme-material
Après avoir installé le thème, définissez conf.py comme suit. Après le réglage, le thème est devenu la conception matérielle.
conf.py
html_theme = 'material'
Recommended Posts