diff --git a/templates/README.md b/templates/README.md index 796d1f6c90a8cff1816ead5f77fa3ee494895fe4..4ac9d63858b50c267766b36da4f1060808b71bf3 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