Scribd
Importer
4 vues3 pages

Guide d'installation de Sphinx

Ce document décrit les étapes pour configurer Sphinx, un outil de documentation. Il inclut des instructions pour l'installation, la création d'un dossier, la configuration des fichiers nécessaires et la génération de la documentation. Les étapes précises comprennent l'utilisation de commandes spécifiques et la modification de fichiers de configuration.

Transféré par

YOUNESS AILAL
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd
4 vues3 pages

Guide d'installation de Sphinx

Ce document décrit les étapes pour configurer Sphinx, un outil de documentation. Il inclut des instructions pour l'installation, la création d'un dossier, la configuration des fichiers nécessaires et la génération de la documentation. Les étapes précises comprennent l'utilisation de commandes spécifiques et la modification de fichiers de configuration.

Transféré par

YOUNESS AILAL
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd

Étapes pour Configurer Sphinx

1/

Installez Sphinx :

```bash

pip install sphinx

```

2/

Créez un dossier nommé `docs` :

```bash

mkdir docs

```

3/

Accédez au dossier `docs` et lancez la commande :

```bash

cd docs

sphinx-quickstart

```

Lorsque demandé :

> Séparer les répertoires source et build (y/n) [n] : **n**

4/

Ouvrez le fichier `docs/[Link]` et ajoutez ce code en haut :


```python

import os

import sys

[Link](0, [Link](".."))

```

Remplacez aussi la section `extensions` par :

```python

extensions = [

"[Link]",

"[Link]",

"[Link]",

```

5/

Exécutez la commande suivante :

```bash

cd ..

sphinx-apidoc -o docs/ drarga/

```

6/

Dans le fichier `docs/[Link]`, remplacez :

```rst

.. toctree::

:maxdepth: 2
:caption: Contents:

```

par :

```rst

.. toctree::

:maxdepth: 2

:caption: Contents:

modules

```

7/

Dans le dossier `docs`, exécutez :

```bash

.\[Link] html

```

Vous aimerez peut-être aussi