forked from ScoDoc/ScoDoc
Modifie test_api.sh pour générer les exemples de la documentation (samples).
This commit is contained in:
parent
933968c99b
commit
9302a173aa
@ -270,6 +270,9 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
|||||||
|
|
||||||
Voir exemples d'utilisation de l'API en Python, dans `tests/api/`.
|
Voir exemples d'utilisation de l'API en Python, dans `tests/api/`.
|
||||||
|
|
||||||
|
!!! info
|
||||||
|
Cette page a été générée par la commande `flask gen-api-doc`, et les exemples de résultats
|
||||||
|
sont créés par `tools/test_api.sh --make-samples`.
|
||||||
|
|
||||||
!!! note "Voir aussi"
|
!!! note "Voir aussi"
|
||||||
|
|
||||||
|
@ -11,13 +11,17 @@
|
|||||||
#
|
#
|
||||||
# Toutes les autres options sont passées telles qu'elles à pytest
|
# Toutes les autres options sont passées telles qu'elles à pytest
|
||||||
#
|
#
|
||||||
|
# Utilisation pour générer des exemples de documentation:
|
||||||
|
# tools/test_api.sh --make-samples
|
||||||
|
#
|
||||||
# Exemples:
|
# Exemples:
|
||||||
# - lancer tous les tests API: tools/test_api.sh
|
# - lancer tous les tests API: tools/test_api.sh
|
||||||
# - lancer tous les tests, en mode debug (arrêt pdb sur le 1er):
|
# - lancer tous les tests, en mode debug (arrêt pdb sur le 1er):
|
||||||
# tools/test_api.sh -x --pdb tests/api
|
# tools/test_api.sh -x --pdb tests/api
|
||||||
# - lancer un module de test, en utilisant un server dev existant:
|
# - lancer un module de test, en utilisant un server dev existant:
|
||||||
# tools/test_api.sh --dont-start-server -x --pdb tests/api/test_api_evaluations.py
|
# tools/test_api.sh --dont-start-server -x --pdb tests/api/test_api_evaluations.py
|
||||||
#
|
# - Générer les samples pour la doc:
|
||||||
|
# tools/test_api.sh --make-samples
|
||||||
#
|
#
|
||||||
# E. Viennet, Fev 2023
|
# E. Viennet, Fev 2023
|
||||||
|
|
||||||
@ -70,10 +74,16 @@ if [ "$#" -eq 0 ]
|
|||||||
then
|
then
|
||||||
echo "Starting pytest tests/api"
|
echo "Starting pytest tests/api"
|
||||||
pytest tests/api
|
pytest tests/api
|
||||||
|
else
|
||||||
|
if [ "$1" = "--make-samples" ]
|
||||||
|
then
|
||||||
|
echo "Generating API documentation samples"
|
||||||
|
python tests/api/make_samples.py -i /tmp/samples.csv
|
||||||
else
|
else
|
||||||
echo "Starting pytest $@"
|
echo "Starting pytest $@"
|
||||||
pytest "$@"
|
pytest "$@"
|
||||||
fi
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
# ------------------
|
# ------------------
|
||||||
if [ "$START_SERVER" -eq 1 ]
|
if [ "$START_SERVER" -eq 1 ]
|
||||||
|
Loading…
Reference in New Issue
Block a user