From 48d3e5bf2881fd271ba864e01edf6c6f48fe78af Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Thu, 19 Dec 2019 01:28:08 +0100 Subject: [PATCH] docs: try to document the dependencies --- docs/Build.sh | 2 ++ docs/find-missing.py | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/Build.sh b/docs/Build.sh index 3a28d289f8..cf871665cf 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -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 diff --git a/docs/find-missing.py b/docs/find-missing.py index 17de121629..5daa3e0c6e 100755 --- a/docs/find-missing.py +++ b/docs/find-missing.py @@ -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 -- 2.20.1