From 4feea1ce09667c8a640532c28ba7ee97ab37ea78 Mon Sep 17 00:00:00 2001
From: Manuel Gunther <siebenkopf@googlemail.com>
Date: Thu, 22 Oct 2015 09:46:18 -0600
Subject: [PATCH] Added the documentation for the test_utils to the Python API
documentation
---
doc/py_api.rst | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/doc/py_api.rst b/doc/py_api.rst
index dfd94d6..46f6f71 100644
--- a/doc/py_api.rst
+++ b/doc/py_api.rst
@@ -31,9 +31,23 @@ Functions
bob.io.base.extensions
bob.io.base.get_config
+Test Utilities
+--------------
+
+These functions might be useful when you are writing your nose tests.
+Please note that this is not part of the default ``bob.io.base`` API, so in order to use it, you have to ``import bob.io.base.test_utils`` separately.
+
+.. autosummary::
+ bob.io.base.test_utils.datafile
+ bob.io.base.test_utils.temporary_filename
+ bob.io.base.test_utils.extension_available
+
Details
-------
.. automodule::
bob.io.base
+
+.. automodule::
+ bob.io.base.test_utils
--
GitLab