aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Kemmer <tkemmer@computer.org>2017-08-11 18:26:50 +0200
committerThomas Kemmer <tkemmer@computer.org>2017-08-11 18:26:50 +0200
commitd5b299c2564ed589f60e0f336fe653f3f03bc69d (patch)
tree3760c85ab32f42406f431bb46fc4cdfe1a063393 /README.rst
parentd57c8a3ea7108ee05381d3a0d58329a1c98707a6 (diff)
downloadcachetools-d5b299c2564ed589f60e0f336fe653f3f03bc69d.tar.gz
Fix #76: Move documentation to RTD.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index c6cbf02..850c41e 100644
--- a/README.rst
+++ b/README.rst
@@ -35,6 +35,9 @@ Multiple cache classes based on different caching algorithms are
implemented, and decorators for easily memoizing function and method
calls are provided, too.
+For more information, please refer to cachetools's online
+documentation_.
+
Installation
------------------------------------------------------------------------
@@ -59,7 +62,10 @@ Project Resources
:target: https://coveralls.io/r/tkem/cachetools
:alt: Test coverage
-- `Documentation`_
+.. image:: https://readthedocs.org/projects/cachetools/badge/?version=latest&style=flat
+ :target: http://cachetools.readthedocs.io/en/latest/
+ :alt: Documentation Status
+
- `Issue Tracker`_
- `Source Code`_
- `Change Log`_
@@ -78,7 +84,7 @@ Licensed under the `MIT License`_.
.. _mapping: http://docs.python.org/dev/glossary.html#term-mapping
.. _cache algorithm: http://en.wikipedia.org/wiki/Cache_algorithms
-.. _Documentation: http://pythonhosted.org/cachetools/
+.. _Documentation: http://cachetools.readthedocs.io/en/latest/
.. _Issue Tracker: https://github.com/tkem/cachetools/issues/
.. _Source Code: https://github.com/tkem/cachetools/
.. _Change Log: https://github.com/tkem/cachetools/blob/master/CHANGES.rst