Skip to content

Commit 58975cb

Browse files
committed
doc: added Dash docset generator
1 parent a7d4ca1 commit 58975cb

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

scripts/mkdoc.sh

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,26 @@ echo "Generating HTML documentation..."
5050

5151
# PDF not supported by PyDoctor
5252

53+
DOC2DASH=`which doc2dash 2>/dev/null || true`
54+
if [ "x$DOC2DASH" != x ]; then
55+
echo "Generating Dash docset..."
56+
"$DOC2DASH" \
57+
--online-redirect-url "https://igraph.org/python/doc/api" \
58+
--name "python-igraph" \
59+
-d "${DOC_API_FOLDER}" \
60+
-f \
61+
"${DOC_API_FOLDER}/html"
62+
DASH_READY=1
63+
else
64+
echo "WARNING: doc2dash not installed, skipping Dash docset generation."
65+
DASH_READY=0
66+
fi
67+
68+
echo ""
69+
echo "HTML API documentation generated in ${DOC_API_FOLDER}/html"
70+
if [ "x${DASH_READY}" = x1 ]; then
71+
echo "Dash docset generated in ${DOC_API_FOLDER}/python-igraph.docset"
72+
fi
73+
5374
cd "$PWD"
5475

0 commit comments

Comments
 (0)