From d472103266171c1af1a097ee4b8e3177af4d89f4 Mon Sep 17 00:00:00 2001
From: Amir Mohammadi <183.amir@gmail.com>
Date: Wed, 5 Oct 2016 12:03:49 +0200
Subject: [PATCH] suggest automatic description replacement in doc/conf.py

---
 templates/README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/templates/README.md b/templates/README.md
index 796d1f6..4ac9d63 100644
--- a/templates/README.md
+++ b/templates/README.md
@@ -215,9 +215,11 @@ $ mkdir -pv doc/img
 $ curl -k --silent https://gitlab.idiap.ch/bob/bob.admin/raw/master/templates/logo.png > doc/img/logo.png
 $ curl -k --silent https://gitlab.idiap.ch/bob/bob.admin/raw/master/templates/favicon.ico > doc/img/favicon.ico
 $ sed -i "s/<PROJECT>/`basename $(pwd)`/g" doc/conf.py
-# the next line is **just** an example, change it accordingly to your project
-# for example, pick the short_description field in setup.py
-$ sed -i "s%<SHORT_DESCRIPTION>%Building of Python/C++ extensions for Bob%g" doc/conf.py
+# the next line will work if the description in setup.py is correct.
+# Otherwise, you need to need to fix "description" in setup.py first.
+# Also this will not work with bob.math, for bob.math use this instead:
+# sed -i "s%<SHORT_DESCRIPTION>%Mathematical functions of Bob%g" doc/conf.py
+$ sed -i "s%<SHORT_DESCRIPTION>%`python setup.py --description`%g" doc/conf.py
 ```
 
 The new documentation configuration allows for two *optional* configuration
-- 
GitLab