Skip to content

Commit

Permalink
Fixed caching autodoc (failed to build). Added link to cache_file.
Browse files Browse the repository at this point in the history
  • Loading branch information
maximecb committed Sep 1, 2017
1 parent a04d101 commit 384e81a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/api/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Caching
-------

.. automodule:: fuel.utils.cache
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
5 changes: 4 additions & 1 deletion docs/caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,7 @@ This variable can also be set through an environment variable as follows:
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``.
|cache_file|_ function.

.. |cache_file| replace:: ``cache_file``
.. _cache_file: api/utils.html#fuel.utils.cache.cache_file

0 comments on commit 384e81a

Please sign in to comment.