From: Martin Quinson <martin.quinson@ens-rennes.fr>
Date: Fri, 3 Jan 2020 22:40:12 +0000 (+0100)
Subject: get useful warnings for broken links in the doc
X-Git-Tag: v3.25~168
X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/c741a8289a7c62109c8db7fb86257c186ee52e26

get useful warnings for broken links in the doc
---

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 7c355ce85a..254b31362f 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -11,7 +11,7 @@ pages:
   - make -j4
   - pip3 install --requirement docs/requirements.txt
   - cd docs
-  - LC_ALL=C.UTF-8 SPHINXOPTS=-vv ./Build.sh
+  - LC_ALL=C.UTF-8 ./Build.sh
   - mv build/html ../public
   # - The CSS contains a reference to a font or something, not something we gonna fix on our side
   # - The javasphinx output does not exist in the git, so the "edit on FramaGit" link is broken.
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c309c22a2b..4f2554a95e 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -144,3 +144,7 @@ html_context = {
     "gitlab_version": "master",  # Version
     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 }
+
+# -- Other options
+
+nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found