diff --git a/README.rst b/README.rst index b22afea3d3676f451d29bc6cb51698ddf879c980..6ef9915a43df5e6ee0a260f6c4ba9b305c393f28 100644 --- a/README.rst +++ b/README.rst @@ -4,6 +4,8 @@ .. image:: https://travis-ci.org/bioidiap/bob.core.svg?branch=master :target: https://travis-ci.org/bioidiap/bob.core +.. image:: http://img.shields.io/badge/docs-latest-orange.png + :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.core/master/index.html .. image:: https://coveralls.io/repos/bioidiap/bob.core/badge.png :target: https://coveralls.io/r/bioidiap/bob.core .. image:: http://img.shields.io/github/tag/bioidiap/bob.core.png @@ -29,8 +31,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.core/master/index.html>`_. + +Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx:: $ sphinx-build -b html doc sphinx @@ -42,7 +45,7 @@ Testing You can run a set of tests using the nose test runner:: - $ nosetests -sv bob.core + $ nosetests -sv .. warning::