#! /bin/bash
#
+# Copyright (c) 2018-2023. The SimGrid Team. All rights reserved.
+
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the license (GNU LGPL) which comes with this package.
+
# Simplistic script to rebuild our documentation with sphinx-build
# If you are missing some dependencies, try: pip3 install --requirement docs/requirements.txt
if [ "x$1" != 'xdoxy' ] && [ -e build/xml ] ; then
echo "Doxygen not rerun: 'doxy' was not provided as an argument"
else
+ set -x
rm -rf build/xml source/api/
- (cd source; doxygen 2>&1; cd ..) | grep -v "is not documented." # XXXXX Reduce the verbosity for now
+ (cd source; doxygen 2>&1; cd ..) | (grep -v "is not documented." || true) # XXXXX Reduce the verbosity for now
+ set +x
fi
-if [ "x$1" != 'xjava' ] && [ -e source/java ] ; then
- echo "javasphinx not rerun: 'java' was not provided as an argument"
+if [ "x$1" != 'xlogs' ] && [ -e build/log_categories.rst ] ; then
+ echo "Log categories not extracted: 'logs' 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"
+ set -x
+ perl ./bin/extract_logs_hierarchy.pl ../ > build/log_categories.rst
+ set +x
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'
+PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&1
set +x
echo
echo "Undocumented examples:"
for ex in $( (cd .. ; \
- find examples/s4u/ -name '*.cpp'; \
- find examples/c/ -name '*.c'; \
+ find examples/cpp/ -name '*.cpp'; \
+ find examples/c/ -name '*.c'; \
find examples/python -name '*.py'; \
) | sort )
do
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 \
+ linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=build/html/_modules build/html \
| grep -v '^#' \
| grep -v 'urlname;parentname;baseref;result;warningstring'
echo "done."