Skip to content
Snippets Groups Projects
Commit 15067adc authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated README by adding a link to the documentation.

parent f6e52fc2
No related branches found
No related tags found
No related merge requests found
......@@ -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::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment