Merge pull request #401 from maximecb/local-cache

Fixed caching autodoc (failed to build). Added link to cache_file.
mila-iqia · Sep 5, 2017 · 3668c6c · 3668c6c
2 parents a0110b0 + 2af256c
commit 3668c6c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -10,6 +10,6 @@ Caching
 -------
 
 .. automodule:: fuel.utils.cache
-:members:
-        :undoc-members:
-        :show-inheritance:
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/caching.rst b/docs/caching.rst
@@ -15,8 +15,8 @@ This variable can also be set through an environment variable as follows:
 
 .. code-block:: bash
 
-    $ export FUEL_LOCAL_DATA_PATH="/home/username/my_local_cache"
+    $ export FUEL_LOCAL_DATA_PATH="/LOCAL_PATH/my_local_cache"
 
 Please note that currently, caching is only implemented in the ``H5PyDataset``.
 In order to add caching to other types of datasets, one should use the
-``cache_file`` function, which is defined in ``fuel/utils/cache.py``.
+:func:`fuel.utils.cache.cache_file` function.