1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
#! /bin/sh
#
# Simplistic script to rebuild our documentation with sphinx-build
# If you are missing some dependencies, try: pip3 install --requirement docs/requirements.txt
# Python needs to find simgrid on my machine, but not ctest -- sorry for the hack
if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi
set -e
if [ "x$1" != 'xdoxy' ] && [ -e build/xml ] ; then
echo "Doxygen not rerun: 'doxy' was not provided as an argument"
else
rm -rf build/xml source/api/
(cd source; doxygen 2>&1; cd ..) | grep -v "is not documented." # XXXXX Reduce the verbosity for now
fi
if [ "x$1" != 'xjava' ] && [ -e source/java ] ; then
echo "javasphinx not rerun: 'java' was not provided as an argument"
else
rm -rf source/java
javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg
rm -f source/java/packages.rst # api_generated/source_java_packages.rst
rm -f source/java/org/simgrid/msg/package-index.rst # api_generated/source_java_org_simgrid_msg_package-index.rst
for f in source/java/org/simgrid/msg/* ; do
# Add the package name to the page titles
(printf "class org.simgrid.msg."; cat $f )>tmp
mv tmp $f
sed -i 's/==/========================/' $f # That's the right length knowing that I add 'class org.simgrid.msg.'
done
# sed -i 's/^.. java:type:: public class /.. java:type:: public class org.simgrid.msg/' source/java/org/simgrid/msg/*
echo "javasphinx relaunched"
fi
PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&1 \
| grep -v 'WARNING: cpp:identifier reference target not found: simgrid$' \
| grep -v 'WARNING: cpp:identifier reference target not found: simgrid::s4u$' \
| grep -v 'WARNING: cpp:identifier reference target not found: boost'
set +x
perl -pe 's/(xlink:href="(?:http|.*\.html))/target="_top" $1/' \
source/img/graphical-toc.svg > build/html/graphical-toc.svg
echo
echo "Undocumented examples:"
for ex in $( (cd .. ; \
find examples/s4u/ -name '*.cpp'; \
find examples/python -name '*.py'; \
) | sort )
do
if grep -q "example-tab:: $ex" ../examples/README.rst ; then :
# echo "found example-tab:: $ex"
elif grep -q "showfile:: $ex" ../examples/README.rst ; then :
else
echo $ex
fi
done
set +e # Don't fail
if [ -e /usr/bin/linkchecker ] ; then
linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=build/html/_modules --ignore-url=public/java/org build/html \
| grep -v '^#' \
| grep -v 'urlname;parentname;baseref;result;warningstring'
echo "done."
else
echo "Install linkchecker to have it executed when you build the doc."
fi
|
