Skip to content

Commit dd60519

Browse files
committed
refacto script
1 parent bd2aecf commit dd60519

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/generate_docs.sh

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/bin/bash
2+
3+
# Chemins vers les packages racines (doivent contenir __init__.py et des sous-modules)
4+
SCALEWAY_PKG="../scaleway/scaleway"
5+
CORE_PKG="../scaleway-core/scaleway_core"
6+
ASYNC_PKG="../scaleway-async/scaleway_async"
7+
8+
# Vérifier que les dossiers racines existent et sont bien des packages
9+
for pkg in "$SCALEWAY_PKG" "$CORE_PKG" "$ASYNC_PKG"; do
10+
if [ ! -d "$pkg" ]; then
11+
echo "❌ Erreur : Le dossier '$pkg' n'existe pas."
12+
exit 1
13+
fi
14+
if [ ! -f "$pkg/__init__.py" ] ; then
15+
echo "⚠️ Attention : '$pkg' ne semble pas être un package Python (pas de __init__.py)."
16+
fi
17+
echo "✅ Package trouvé : $pkg"
18+
done
19+
20+
# Exporter PYTHONPATH pour que tous les modules soient accessibles
21+
export PYTHONPATH="..:$PYTHONPATH"
22+
23+
# Générer la doc pour chaque package racine (pdoc explore automatiquement les sous-modules)
24+
echo "📚 Génération de la documentation avec pdoc..."
25+
poetry run pdoc \
26+
-o html \
27+
-d google \
28+
"$SCALEWAY_PKG" \
29+
"$CORE_PKG" \
30+
"$ASYNC_PKG"
31+
32+
if [ $? -eq 0 ]; then
33+
echo "✅ Documentation générée avec succès dans le dossier 'html/'."
34+
else
35+
echo "❌ Échec de la génération de la documentation."
36+
exit 1
37+
fi

0 commit comments

Comments
 (0)