diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-26 14:48:33 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-26 17:04:15 -0500 |
| commit | e203a48cdf58eda51f85b27d3eaf852bd9da941c (patch) | |
| tree | a384f2ab226fecc66b81bf288d51f2acb0b3b960 /requests_cache | |
| parent | 31a760cfb998d31cdeb8f79e65e1f1765cb2e3c9 (diff) | |
| download | requests-cache-e203a48cdf58eda51f85b27d3eaf852bd9da941c.tar.gz | |
Reorganize user docs: break down User Guide and Advanced Usage sections into smaller pages
Diffstat (limited to 'requests_cache')
| -rw-r--r-- | requests_cache/backends/__init__.py | 4 | ||||
| -rw-r--r-- | requests_cache/backends/base.py | 4 | ||||
| -rw-r--r-- | requests_cache/backends/filesystem.py | 2 | ||||
| -rw-r--r-- | requests_cache/backends/sqlite.py | 2 | ||||
| -rw-r--r-- | requests_cache/serializers/__init__.py | 2 |
5 files changed, 6 insertions, 8 deletions
diff --git a/requests_cache/backends/__init__.py b/requests_cache/backends/__init__.py index bc48161..870511c 100644 --- a/requests_cache/backends/__init__.py +++ b/requests_cache/backends/__init__.py @@ -1,6 +1,4 @@ -"""Classes and functions for cache persistence. See :ref:`user_guide:cache backends` for general -usage info. -""" +"""Classes and functions for cache persistence. See :ref:`backends` for general usage info.""" # flake8: noqa: F401 from inspect import signature from logging import getLogger diff --git a/requests_cache/backends/base.py b/requests_cache/backends/base.py index e580d8b..4186f60 100644 --- a/requests_cache/backends/base.py +++ b/requests_cache/backends/base.py @@ -39,7 +39,7 @@ class BaseCache: Lower-level storage operations are handled by :py:class:`.BaseStorage`. - To extend this with your own custom backend, see :ref:`advanced_usage:custom backends`. + To extend this with your own custom backend, see :ref:`custom-backends`. """ def __init__( @@ -247,7 +247,7 @@ class BaseStorage(MutableMapping, ABC): ``BaseStorage`` also contains a serializer module or instance (defaulting to :py:mod:`pickle`), which determines how :py:class:`.CachedResponse` objects are saved internally. See - :ref:`user_guide:serializers` for details. + :ref:`serializers` for details. Args: serializer: Custom serializer that provides ``loads`` and ``dumps`` methods diff --git a/requests_cache/backends/filesystem.py b/requests_cache/backends/filesystem.py index 687dbf6..6ab23d4 100644 --- a/requests_cache/backends/filesystem.py +++ b/requests_cache/backends/filesystem.py @@ -24,7 +24,7 @@ Or as YAML (requires ``pyyaml``): Cache Files ^^^^^^^^^^^ -* See :ref:`user_guide:cache files` for general info on cache files +* See :ref:`files` for general info on specifying cache paths * The path for a given response will be in the format ``<cache_name>/<cache_key>`` * Redirects are stored in a separate SQLite database, located at ``<cache_name>/redirects.sqlite`` * Use :py:meth:`.FileCache.paths` to get a list of all cached response paths diff --git a/requests_cache/backends/sqlite.py b/requests_cache/backends/sqlite.py index 41e63ad..2ae5e40 100644 --- a/requests_cache/backends/sqlite.py +++ b/requests_cache/backends/sqlite.py @@ -12,7 +12,7 @@ for requests-cache. Cache Files ^^^^^^^^^^^ -* See :ref:`user_guide:cache files` for general info on cache files +* See :ref:`files` for general info on specifying cache paths * If you specify a name without an extension, the default extension ``.sqlite`` will be used In-Memory Caching diff --git a/requests_cache/serializers/__init__.py b/requests_cache/serializers/__init__.py index eeceecb..68ead1b 100644 --- a/requests_cache/serializers/__init__.py +++ b/requests_cache/serializers/__init__.py @@ -1,4 +1,4 @@ -"""Response serialization utilities. See :ref:`user_guide:serializers` for general usage info. +"""Response serialization utilities. See :ref:`serializers` for general usage info. """ # flake8: noqa: F401 from .cattrs import CattrStage |