Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
docs: try to document the dependencies
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 19 Dec 2019 00:28:08 +0000 (01:28 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 19 Dec 2019 00:29:04 +0000 (01:29 +0100)
docs/Build.sh
docs/find-missing.py

index 3a28d28..cf87166 100755 (executable)
@@ -2,6 +2,8 @@
 #
 # 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
 
index 17de121..5daa3e0 100755 (executable)
@@ -1,8 +1,7 @@
 #! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2019. The SimGrid Team.
-# All rights reserved.
+# Copyright (c) 2019. 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.
@@ -12,6 +11,8 @@ Search for symbols documented in both the XML files produced by Doxygen and the
 but not documented with autodoxy in the RST files.
 
 This script is tailored to SimGrid own needs and should be made more generic for autodoxy.
+
+If you are missing some dependencies, try:  pip3 install --requirement docs/requirements.txt
 """
 
 import fnmatch