From a27d46598facac9a9988259ba708b166af5e080d Mon Sep 17 00:00:00 2001
From: Manuel Guenther <manuel.guenther@idiap.ch>
Date: Mon, 23 Jun 2014 17:30:47 +0200
Subject: [PATCH] Updated README by adding a link to the documentation.
---
README.rst | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/README.rst b/README.rst
index 63f677f..8672712 100644
--- a/README.rst
+++ b/README.rst
@@ -4,6 +4,8 @@
.. image:: https://travis-ci.org/bioidiap/bob.io.base.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.io.base
+.. image:: http://img.shields.io/badge/docs-latest-orange.png
+ :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.io.base/master/index.html
.. image:: https://coveralls.io/repos/bioidiap/bob.io.base/badge.png
:target: https://coveralls.io/r/bioidiap/bob.io.base
.. image:: http://img.shields.io/github/tag/bioidiap/bob.io.base.png
@@ -28,8 +30,9 @@ the package and run test units.
Documentation
-------------
-You can generate the documentation for this package, after installation, using
-Sphinx::
+The latest version of the documentation can be found `here <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.io.base/master/index.html>`_.
+
+Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx::
$ sphinx-build -b html doc sphinx
@@ -41,7 +44,7 @@ Testing
You can run a set of tests using the nose test runner::
- $ nosetests -sv bob.io.base
+ $ nosetests -sv
.. warning::
--
GitLab