Tabula

Nettoyer vieux containers Docker

Pierre — 2025-08-12T13:26:09Z

journalctl --vacuum-size=500M sudo find /var/log/ -type f -regex '.*\.[0-9]+\.gz$' -delete docker system df docker system prune -af --volumes

Mettre à jour tous les dockers compose

Pierre — 2025-08-12T13:21:08Z

Attention :

* Cela ne fonctionne que pour les docker compose qui tournent actuellement
* Si un docker compose a plusieurs containers, alors le pull sera relancé plusieurs fois pour l'ensemble des docker compose !

docker ps --format '{{.Names}} {{.Mounts}}' | while read container mounts; do echo "> Conteneur: $container" path=$(docker inspect $container | grep 'com.docker.compose.project.working_dir' | awk -F': ' '{print $2}' | tr -d '",') echo "> Chemin: $path" cd $path docker compose stop docker compose pull docker compose up -d cd - echo "" done

Avoir un environnement de travail sécurisé

Pierre — 2024-11-12T19:39:41Z

$ run --rm -it -v /tmp/mydir:/tmp alpine:latest /bin/bash $ apk update && apk upgrade $ apk add gcc git python3 py-pip $ pip3 install logging binascii json struct os glob --break-system-packages

(attention : gcc : 224 Mo)
Puis faire ce que l'on veut, par exemple :

$ git clone https://github.com/fcoiffie/decode-ColorNote.git

Transférer des container docker

Pierre — 2024-08-31T09:16:07Z

Sur l'ancien serveur

Préparation : récupérer les fichiers non présents dans le dossier à l'origine

Recopier le fichier de config nginx nettoyé du certificat SSL

SERVICE_DIR="myservice" && SERVICE_URL="exemple.fr" && CONF_FILE=$(grep -l "server_name.*$SERVICE_URL" /etc/nginx/conf.d/*.conf) && cp "$CONF_FILE" "$SERVICE_DIR/" && sed -i '/# managed by Certbot/d; /ssl_certificate/d; /ssl_certificate_key/d; /include \/etc\/letsencrypt/d; /ssl_dhparam/d; /if ($host =/d; /listen 443 ssl;/d; /return 301/d; /return 404;/d' "$SERVICE_DIR/$(basename "$CONF_FILE")"

Attention : supprimer la dernière section et repasser le listen 80; dans la section "server" du haut !

Récupérer les volumes qui ne sont pas des fichiers (s'il y en a)

$ docker volume ls

docker run --rm -v mydockervolume:/data -v $(pwd):/backup alpine tar czvf /backup/mydockervolume.tar.gz -C /data

1. Créer une archive

a. En une commande

 SERVICE_DIR="myservice" && VOLUMES_TO_BACKUP="volumeOne volumeTwo" && cd "$SERVICE_DIR" && docker run --rm -v $(pwd):/backup alpine tar -C /backup -cvf /backup/volume_backup.tar $VOLUMES_TO_BACKUP && echo "volumes: $VOLUMES_TO_BACKUP saved" && cd .. && tar cvf ${SERVICE_DIR}.tar --exclude-from=<(echo -e "${VOLUMES_TO_BACKUP// /\\n}\nother_file.txt") "$SERVICE_DIR" && echo "service: $SERVICE_DIR saved"

Changer "myservice" et "volumeOne volumeTwo" par le nom du répertoire du service et par les différents volumes à enlever.
Ensuite, on a directement une archive à envoyer

b. en plusieurs commandes

1. Créer une archive avec les volumes

$ docker run --rm -v $(pwd):/backup alpine tar -C /backup -cvf /backup/volume_backup.tar volumeOne volumeTwo volumeThree

2. Créer une archive avec tous les fichiers du dossier, sauf les volumes

$ tar cvf myservice.tar --exclude-from=<(echo -e "config\naddons\nweb-datas\n*~") myservice

2. Envoyer l'archive

rsync -avzP --delete -e "ssh -p 22 -T -o Compression=no -x" /opt/docker/myservice.tar username@ip:/opt/docker/

Vérifier l'intégrité de l'archive (checksum) : l'option "p" est changée par "c"
rsync -avzc —delete -e "ssh -p 22 -T -o Compression=no -x" /opt/docker/myservice.tar username@ip :/opt/docker/

3. Extraire sur le serveur distant

Attention à ouvrir les ports 80, 88 et 334 (http, https) si ce n'est pas encore le cas.

Il faut que rsync, docker, nginx et letsencrypt soient installés.

SERVICE_DIR="myservice" && echo "" && tar xvf ${SERVICE_DIR}.tar && cd $SERVICE_DIR && [ -f "volume_backup.tar" ] && (tar -xvf "volume_backup1.tar" 2>/dev/null || echo "**WARNING** Il n'y a pas de volume à extraire.") && rm -rf volume_backup.tar && cd .. && echo ""

Configurer letsencrypy

Pour rappel, voici un tuto https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-debian-11

Et il faut que l'utilisateur ai les droits ou être en root :
Pour donner à l'utilisateur les droits :
# vi /etc/nginx/nginx.conf # : user : doit être sur www-data
# chgrp www-data /etc/nginx/conf.d
# chmod g+w /etc/nginx/conf.d/
# # ls -la /etc/nginx/conf.d

# cp myservice/myurl.fr.conf /etc/nginx/conf.d/

Décompresser les volumes docker

docker run --rm -v myvolume:/data -v $(pwd):/backup alpine tar xzvf /backup/myvolume.tar.gz -C /data

============

Ce qui m'a aidé (à nettoyer)

(Perplexity)

Pour transférer entièrement un volume Docker d'un VPS vers un autre, voici la procédure recommandée :

## Étape 1 : Sauvegarde du volume sur le VPS source

1. Arrêtez le conteneur utilisant le volume :

docker stop

2. Créez une archive tar du volume :

docker run --rm -v :/source -v $(pwd):/backup alpine tar cvf /backup/volume_backup.tar /source

Cette commande crée une archive volume_backup.tar dans le répertoire courant.

## Étape 2 : Transfert de l'archive vers le nouveau VPS

Utilisez scp pour transférer l'archive :

scp volume_backup.tar utilisateur@nouveau_vps:/chemin/destination/

## Étape 3 : Restauration du volume sur le nouveau VPS

1. Sur le nouveau VPS, créez un nouveau volume Docker :

docker volume create

2. Restaurez les données dans le nouveau volume :

docker run --rm -v :/destination -v /chemin/destination:/backup alpine sh -c "cd /destination && tar xvf /backup/volume_backup.tar --strip 1"

## Étape 4 : Utilisation du volume restauré

Modifiez votre fichier docker-compose.yml ou la commande docker run pour utiliser le nouveau volume :

volumes: - :/chemin/dans/conteneur

## Considérations importantes

– **Taille du volume** : Pour les volumes volumineux, envisagez de compresser l'archive ou d'utiliser un transfert par morceaux[1].

– **Cohérence des données** : Assurez-vous que le conteneur est arrêté pendant la sauvegarde pour garantir l'intégrité des données[4].

– **Permissions** : Vérifiez que les permissions des fichiers sont correctement préservées lors de la restauration[2].

– **Noms de volumes** : Adaptez les noms des volumes dans vos configurations Docker sur le nouveau VPS si nécessaire[5].

En suivant ces étapes, vous pouvez transférer efficacement et en toute sécurité un volume Docker complet d'un VPS à un autre, en préservant toutes les données et la structure du volume.

Citations :
[1] https://bitlaunch.io/blog/how-to-transfer-docker-volumes-between-your-vps-and-local-pc/
[2] https://vsys.host/how-to/transferring-a-docker-volume-to-another-host
[3] https://www.ionos.fr/digitalguide/serveur/know-how/volumes-de-conteneurs-docker/
[4] https://docs.docker.com/engine/storage/volumes/
[5] https://www.reddit.com/r/docker/comments/18oxsk7/how_to_move_everything/?tl=fr
[6] https://mondedie.fr/d/10982-migrations-conteneurs
[7] https://www.youtube.com/watch?v=0ZcePSwZ41w
[8] https://cnil.fr/fr/les-outils-de-securisation-dapplications-web-dans-linformatique-en-nuage-cloud

=====================================================

Pour copier efficacement et complètement les données d'un VPS vers un autre en utilisant rsync, tout en maximisant la vitesse de transfert, voici la procédure recommandée :

## Préparation

1. Assurez-vous que rsync est installé sur les deux VPS. Si ce n'est pas le cas, installez-le :

sudo apt-get install rsync # Pour Debian/Ubuntu sudo yum install rsync # Pour CentOS/RHEL

2. Vérifiez que vous avez un accès SSH aux deux VPS.

## Commande rsync optimisée

Utilisez la commande suivante depuis le VPS de destination :

rsync -avzP --delete --exclude={"/dev/*","/proc/*","/sys/*","/tmp/*","/run/*","/mnt/*","/media/*","/lost+found"} -e "ssh -p 22 -T -c aes128-gcm@openssh.com -o Compression=no -x" root@IP_SOURCE:/ /

## Explication des options

– -a : mode archive (préserve les permissions, propriétés, etc.)
– -v : mode verbeux
– -z : compresse les données pendant le transfert
– -P : montre la progression et permet la reprise des transferts interrompus
– --delete : supprime les fichiers de destination qui n'existent plus à la source
– --exclude : exclut certains répertoires non nécessaires ou problématiques
– -e "ssh ..." : options SSH pour optimiser la vitesse :
- -T : désactive l'allocation de pseudo-terminal
- -c aes128-gcm@openssh.com : utilise un chiffrement rapide
- -o Compression=no : désactive la compression SSH (rsync s'en charge)
- -x : désactive le transfert X11

## Considérations importantes

1. **Arrêt des services** : Arrêtez les services critiques sur le VPS source pour assurer la cohérence des données.

2. **Vérification** : Après le transfert, vérifiez l'intégrité des données :

rsync -avzc --delete [mêmes options que précédemment]

L'option -c effectue une vérification par checksum.

3. **Permissions** : Assurez-vous que les permissions sont correctement transférées, particulièrement pour les fichiers système critiques.

4. **Bande passante** : Cette méthode utilise beaucoup de bande passante. Assurez-vous que cela ne pose pas de problème avec votre fournisseur VPS.

5. **Temps** : Le processus peut prendre plusieurs heures selon la quantité de données et la vitesse de connexion.

En suivant cette méthode, vous obtiendrez une copie complète et fidèle de votre VPS source vers le VPS de destination, tout en optimisant la vitesse du transfert.

Citations :
[1] https://www.hostwinds.fr/tutorials/how-to-sync-a-vps-to-your-local-computer-with-rsync-linux
[2] https://www.hostinger.fr/tutoriels/commande-rsync-linux
[3] https://eroambahub.com/transferer-vos-donnees-autrement-rsync-et-scp/
[4] https://www.ionos.fr/digitalguide/serveur/outils/creer-une-sauvegarde-de-serveur-avec-rsync/
[5] https://www.easyhoster.com/aide/migration-rsync/
[6] https://www.scrample.xyz/sauvegarde-avec-rsync/
[7] https://bitlaunch.io/blog/how-to-transfer-docker-volumes-between-your-vps-and-local-pc/
[8] https://www.webhi.com/how-to/fr/comment-utiliser-rsync-pour-copier-des-fichiers-via-ssh/

Annuaire de sites catholiques généralistes et d'informations

Pierre — 2024-04-13T20:24:35Z

Nota : ce classement est fait à titre personnel, vous avez le droit de ne pas être d'accord avec celui-ci, mais j'essaye de le faire le plus honnêtement possible et dans un esprit d'ouverture. Les sites présentant des positions fermes et sans justification au regard de l'Amour de Dieu seront automatiquement dévalorisé dans ce classement, bien que certains de leurs articles puissent être pertinents et intéressants

Pratiques

Messes

Horaire des messes : https://messes.info

Aide : http://aide.egliseinfo.catholique.fr
Contributions : http://aide.egliseinfo.catholique.fr/contributeurs

Partitions pour la messe : https://secli.cef.fr

Grégorien :
— https://gregobase.selapa.net/scores.php
— https://www.gregorian-chant-hymns.com

Informations générales sur la liturgie : https://liturgie.catholique.fr

Le site propose beaucoup de ressources

Site de l'AELF (Bible, liturgie des heures : https://aelf.org )

De nombreux sites reprennent leurs données, avec plus ou moins de valeur ajoutée, je ne les listerai pas ici.

Bible annotée : https://bibleart.com

Bible de Jérusalem annotée, et en ligne

Événements

Jeunes à Paris : http://www.jeunesaparis.org

Diocèse de Paris, mais propose des retraites parfois en dehors de Paris aussi

Cathosphère : https://cathosphere.co

Application contributive

Église en France : autres sites

Portail : https://eglise.catholique.fr

Saint du jour : https://nominis.cef.fr

Église romaine : autres sites

vatican.va

Documents du Vatican

Actualités

Sites officiels

https://www.vatican.va/content/vatican/fr.html
https://www.vaticannews.va/fr.html : VaticanNews

Agrégateur

cathoscan.com : Très complet

Autres sites d'actualités recommandés

https://fr.zenit.org : l'actualité romaine
https://fr.aleteia.org : Un peu racolleur mais ok (source acceptable par Wikipédia, mais à éviter)
https://www.famillechretienne.fr : incontournable, droite libérale-conservatrice
https://www.france-catholique.fr : très conservateur
https://www.revue-etudes.com : Magasine jésuite très intéressant
https://www.laciviltacattolica.fr : ==> à revoir
https://www.terresainte.net : ==> à revoir
https://lanef.net : conservateur
https://l1visible.com

Blogs

https://www.larebellution.com

Édification

Cathéchismes

Tous les sites ici sont sous la direction d'un prêtre missionné pour cela

L'Amour Vaincra : https://academy.lamourvaincra.com

Généraliste, à destination des jeunes (16-30 ans) principalement

Théodom : https://www.theodom.org

Théologie, présenté par des dominicains, plus poussé que l'Amour Vaincra.

Porta Fidei : https://portafidei.fr/

Semble à destination des autres confessions/religions, contenu plutôt light

Sur la messe

Pour les servants de messe : https://www.ceremoniaire.net
PGMR :
MR (Missel Romain) :

Documents officiels de l'Église catholique

CEC (Catéchisme de l'Église catho) :
CIC (Code du Droit Canonique) :
DSE (Compendium de la Doctrine Sociale) :

Autres sites pour se former

Couple, cheminement, fiancailles, mariage : https://fiancailles.org

Site de questions/réponses (développées), permettant d'avoir des pistes de réflexion

Agrégateurs

https://www.holychatter.com
https://theostream.com/ catho, protestant, allant à l'encontre du CEC potentiellement...

Déconseillés

https://unpretrevousrepond.org => pas toujours très éclairé
https://gotquestions.org => protestant

À ranger

Migration Gandi -> Infomaniak

Pierre — 2024-01-09T11:15:14Z

Todo

- Desktop

Configuration mails & agendas

Pierre — 2024-01-09T11:15:10Z

### Thunderbird

#### Configuration Gnome3
Mettre Thunderbird par défaut :
– Mails : ??
– Calendrier : org.gnome.desktop.default-applications.office.calendar > thunderbird --calendar
– Tâches : org.gnome.desktop.default-applications.office.tasks > ???

– Plugin gnome3 : ??

#### Dans Thunderbird
– Radicale : Lecture : ok | écriture : ok
– Gandi : Lecture : ok | écriture : pas ok
– Infomaniak : Lecture : ok | écriture : ok ATTENTION : utiliser l'assistant de synchronisation pour pouvoir avoir l'accès en écriture ! https://config.infomaniak.com

Python - test unitaire

Pierre — 2023-06-03T15:06:32Z

Préambule : toute fonction Python n'a pas vocation à accueillir des tests unitaires.
Les tests unitaires ne sont utiles que pour des fonctions "outils", pas pour des codes complexes avec mes milliers de paramètres.

Débuter les tests unitaires

Principe

Le test unitaire consiste à tester le comportement d'une fonction pour s'assurer que pour une entrée donnée, le résultat donne bien la sortie attendue.
Cela permet notamment de s'assurer de la non-regression (qu'une modification dans le code ne va pas créer une erreur qui se propage dans un code existant).

Installation

Ici, j'utilise le paquet converage.py (https://coverage.readthedocs.io/en/coverage-5.0.4/index.html)

$ pip3 install coverage

Utilisation

Intro Ici, le test va s'effectuer automatiquement, sans que l'on ait à préciser le nom des fichiers : l'avantage est que cela permet d'avoir plusieurs fichiers tests/test_monmodule1.py assez petit et donc qu'il est facile de s'y retrouver.
L'inconvénient est que l'on n'a pas la main sur tout...

Remarque : Il faut se placer dans le dossier ./tests (si on y a mis ses tests)

* Avant de lancer le test, il faut s'assurer qu'il n'y ait pas d'anciennes données, sans quoi le test risque de se faire dedans aussi, ce qui ne marchera pas !

$ coverage erase

* Lancer le test, avec une détection automatique des fichiers sources

$ python3 --branch -m unittest discover

* Créer le rapport

$ coverage report

* Créer une copie des sources dans ./tests/Annotate et y mettre les annotations d'utilisation

$ coverage annotate -d ./Annotate

Test et gitlab

Intégration continue

Extrait du .gitlab-ci.yml

test: stage: test script: - echo "Testing..." - pip3 install .[test] - cd tests && coverage erase - coverage run -m unittest discover - coverage report - coverage xml - sed -i 's|" filename="|" filename="./|g' coverage.xml coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/' artifacts: paths: - tests/coverage.xml reports: coverage_report: coverage_format: cobertura path: tests/coverage.xml

Quelques remarques :
* Ici, les modules pour le test sont précisé dans extra_requires/doc du fichier setup.cfg
* Je ne pourrais pas dire à quoi servent individuellement toutes ces lignes (en particulier le sed, et les balises "coverage" et "artifacts", mais visiblement, elles sont nécessaires. Quand je saurais, j'éditerais cet article.

Ajout d'un badge dans Gitlab

Parceque c'est inutile, donc indispensable, mais tout de même plus joli ^^
(sans compter que ça donne mauvaise conscience d'avoir un mauvais rating...)

Il se présente sous la forme :

![coverage](https://gitlab.example.com///badges//coverage.svg?job=coverage)

Et on peut avoir le lien directement en allant dans :
`project > settings > CI/CD > General Pipelines [expand] > Pipeline Status

Ressources

* Visualisation dans Gitlab : https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html
* Inclure à la doc Sphinx : https://stackoverflow.com/questions/65944916/how-to-use-sphixs-sphinx-ext-coverages-coverage-show-missing-items https://www.sphinx-doc.org/ar/master/usage/extensions/coverage.html
* https://gricad-gitlab.univ-grenoble-alpes.fr/continuous-everything/ci
* https://docs.gitlab.com/ee/ci/testing/test_coverage_visualization.html#python-example

Création d'un package Python (Pypi)

Pierre — 2023-05-29T20:56:52Z

* https://test.pypi.org/manage/project/ Dans le doute, passer par un test !!!
* https://pypi.org/manage/project/

Arborescence et fichiers

Arborescence du projet

git_my_name_module ├── docs │ ├── make.bat │ ├── Makefile │ └── source │ ├── conf.py │ ├── index.rst │ ├── parserhtml.rst │ └── readme.rst ├── LICENSE ├── README.md ├── requirements.txt ├── setup.cfg ├── setup.py └── src ├── my_name_module │ ├── __init__.py │ ├── _members.py │ └── ... └── tests ├── __init__.py └── test_my_name_module.py

setup.cfg :

# setup.cfg file at the root directory [metadata] name = my_name_module version = 0.0.1a0 author = Pierre description = Une courte description (bandeau de Pypi) long_description = file:README.md long_description_content_type = text/markdown url = url_doc_par_exemple project_urls = Source Code = url_git keywords = mots-clefs [options] python_requires = >=3.9, <4 install_requires = module>=version package_dir= =src packages=my_name_module [options.extras_require] doc = sphinx==6.2.1 sphinx-rtd-theme==1.2.1 myst-parser==1.0.0 tests = pytest

setup.py :

import sys if __name__ == '__main__': try: import sphinx except ImportError: sphinxInstalled=False else: sphinxInstalled=True #endTry if not sphinxInstalled: sys.stderr.write(f"> Warning, Sphinx is not installed ; I'll try it.\n") #endIf setup() #endIf

Préinstallation

* Il est important de vérifier que le module marche bien avant (sur Pypi, impossible de supprimer module pour rollback la version !)

$ python3 -m venv pppmod $ source pppmod/bin/activate $ cd git_my_name_module $ pip3 install --upgrade --force-reinstall . $ python3 > import my_name_module > my_name_module.MyClass() $ pip uninstall my_name_module $ deactivate # Quitter l'environnement

* Si toutes les étapes précédentes sont bonnes, alors on peut passer à la suite : la création du module proprement dit et l'upload

$ python3.9 setup.py sdist bdist_wheel $ twine upload dist/my_name_module-0.0.1a0.tar.gz $ source pppmod/bin/activate $ pip3 install my_name_module

À faire

* Compiler !

Sources

* https://towardsdatascience.com/create-your-own-python-package-and-publish-it-into-pypi-9306a29bc116
* https://sebsauvage.net/streisand.me/sametmax/?20181206_110748_Vive_setup.cfg__et_mort_a_pyproject.toml___
* https://stackoverflow.com/questions/32688688/how-to-write-setup-py-to-include-a-git-repository-as-a-dependency
* https://peps.python.org/pep-0440/#post-releases

Badges :

* https://docs.gitlab.com/ee/user/project/badges.html
* https://docs.gitlab.com/ee/api/project_badges.html
* https://gitlab.com/gitlab-org/gitlab/-/issues/29457

Génération d'une documentation d'API interactive

Pierre — 2023-05-27T08:36:25Z

Attention : je mets ici mes notes, générées par ChatGPT, mais ça ne fonctionne pas !

1. Installez le package nécessaire pour intégrer Swagger UI ou ReDoc. Par exemple, pour Swagger UI, vous pouvez installer sphinxcontrib-httpdomain en utilisant pip :

pip install sphinxcontrib-httpdomain

2. Ajoutez les directives HTTP appropriées dans vos fichiers de documentation pour documenter votre API en utilisant la syntaxe de sphinxcontrib-httpdomain. Vous pouvez utiliser les directives telles que http:get, http:post, etc., pour décrire les endpoints de l'API et leurs paramètres.

3. Pour intégrer Swagger UI, vous pouvez utiliser l'extension Sphinx appelée sphinxcontrib-httpdomain avec le thème sphinx_rtd_theme. Assurez-vous d'avoir ces extensions installées. Ajoutez les lignes suivantes dans votre fichier conf.py :

extensions = [ # ... 'sphinxcontrib.httpdomain', 'sphinx_rtd_theme', # ... ] html_theme = 'sphinx_rtd_theme'

4. Générez votre documentation Sphinx en utilisant la commande appropriée, comme make html si vous utilisez le Makefile fourni avec Sphinx.

5. Intégrez Swagger UI ou ReDoc dans votre documentation générée. Pour cela, vous pouvez utiliser les directives de sphinxcontrib-httpdomain spécifiques à Swagger UI ou ReDoc.

Pour intégrer Swagger UI ou ReDoc dans votre documentation Sphinx, vous pouvez utiliser les directives spécifiques fournies par sphinxcontrib-httpdomain. Voici les détails pour chaque option :

Swagger UI

Pour intégrer Swagger UI, utilisez la directive http:swagger-ui dans votre fichier de documentation Sphinx. Voici un exemple :

.. http:swagger-ui:: /path/to/swagger.json

Voici un exemple de fichier swagger.json correspondant à l'exemple d'API que j'ai donné pour la documentation Sphinx :

{ "openapi": "3.0.0", "info": { "title": "Example API", "version": "1.0.0" }, "paths": { "/users/{id}": { "get": { "summary": "Get user details", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "param1", "in": "query", "schema": { "type": "string" } }, { "name": "param2", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "404": { "description": "User not found" } } } } } }

Dans cet exemple, nous avons un endpoint GET /users/id avec deux paramètres de requête optionnels (param1 et param2). Les paramètres sont définis dans le tableau parameters avec leurs noms, emplacements (path ou query), et types (string dans cet exemple).

Les codes de statut de réponse attendus sont définis dans le tableau responses, avec les descriptions correspondantes.

Cet exemple de fichier swagger.json peut être utilisé pour générer la documentation interactive de votre API en utilisant Swagger UI ou ReDoc. Assurez-vous d'adapter ce fichier en fonction de votre API réelle et de ses endpoints.

Remplacez /path/to/swagger.json par le chemin relatif vers votre fichier de spécification OpenAPI (par exemple, un fichier JSON ou YAML) qui décrit votre API.

Assurez-vous d'avoir installé sphinxcontrib-httpdomain et sphinx_rtd_theme et que ces extensions sont ajoutées dans la configuration de Sphinx (conf.py).

Après avoir généré votre documentation Sphinx, vous verrez l'interface interactive de Swagger UI affichant votre documentation API avec la possibilité d'explorer et de tester les endpoints.

ReDoc

Pour intégrer ReDoc, utilisez la directive http:redoc dans votre fichier de documentation Sphinx. Voici un exemple :

rst

.. http:redoc: : /path/to/redoc.html

Remplacez /path/to/redoc.html par le chemin relatif vers votre fichier HTML contenant la configuration ReDoc.

Assurez-vous d'avoir installé sphinxcontrib-httpdomain et sphinx_rtd_theme et que ces extensions sont ajoutées dans la configuration de Sphinx (conf.py).

Après avoir généré votre documentation Sphinx, vous verrez l'interface interactive de ReDoc affichant votre documentation API avec la possibilité d'explorer et de tester les endpoints.

Assurez-vous d'avoir correctement configuré votre fichier de spécification OpenAPI pour que Swagger UI ou ReDoc puisse l'utiliser pour afficher l'interface interactive.

6. Régénérez votre documentation Sphinx pour prendre en compte les modifications.