Commit 1d2c7310 authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated README by adding a link to the documentation.

parent aa340b7b
......@@ -4,6 +4,8 @@
.. image:: https://travis-ci.org/bioidiap/bob.io.video.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.io.video
.. image:: http://img.shields.io/badge/docs-latest-orange.png
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.io.video/master/index.html
.. image:: https://coveralls.io/repos/bioidiap/bob.io.video/badge.png
:target: https://coveralls.io/r/bioidiap/bob.io.video
.. image:: http://img.shields.io/github/tag/bioidiap/bob.io.video.png
......@@ -69,8 +71,9 @@ If any of the components is not installed on paths accessible by
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.video/master/index.html>`_.
Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx::
$ sphinx-build -b html doc sphinx
......@@ -93,7 +96,7 @@ Testing
You can run a set of tests using the nose test runner::
$ nosetests -sv bob.io.video
$ nosetests -sv
.. warning::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment