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