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

Updated README by adding a link to the documentation.

parent 9610e2f5
No related branches found
No related tags found
No related merge requests found
...@@ -4,6 +4,8 @@ ...@@ -4,6 +4,8 @@
.. image:: https://travis-ci.org/bioidiap/bob.io.base.svg?branch=master .. image:: https://travis-ci.org/bioidiap/bob.io.base.svg?branch=master
:target: https://travis-ci.org/bioidiap/bob.io.base :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 .. image:: https://coveralls.io/repos/bioidiap/bob.io.base/badge.png
:target: https://coveralls.io/r/bioidiap/bob.io.base :target: https://coveralls.io/r/bioidiap/bob.io.base
.. image:: http://img.shields.io/github/tag/bioidiap/bob.io.base.png .. image:: http://img.shields.io/github/tag/bioidiap/bob.io.base.png
...@@ -28,8 +30,9 @@ the package and run test units. ...@@ -28,8 +30,9 @@ the package and run test units.
Documentation Documentation
------------- -------------
You can generate the documentation for this package, after installation, using 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>`_.
Sphinx::
Otherwise, you can generate the documentation for this package yourself, after installation, using Sphinx::
$ sphinx-build -b html doc sphinx $ sphinx-build -b html doc sphinx
...@@ -41,7 +44,7 @@ Testing ...@@ -41,7 +44,7 @@ Testing
You can run a set of tests using the nose test runner:: You can run a set of tests using the nose test runner::
$ nosetests -sv bob.io.base $ nosetests -sv
.. warning:: .. 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