.. Note: backend module docs are auto-generated with apidoc; the remaining modules are manually
   added here for more custom formatting.

API Reference
=============
This section covers all the public interfaces of requests-cache.

.. contents::
    :local:
    :depth: 2

Sessions
--------
.. Explicitly show inherited method docs on CachedSession instead of CachedMixin
.. autoclass:: requests_cache.session.CachedSession
    :members: send, request, cache_disabled, remove_expired_responses
    :show-inheritance:

.. autoclass:: requests_cache.session.CacheMixin

Patching
--------
.. automodule:: requests_cache.patcher
    :members:

Responses
---------
.. autoclass:: requests_cache.response.CachedResponse
    :members:
    :inherited-members:
    :show-inheritance:

.. autoclass:: requests_cache.response.CachedHTTPResponse
    :members:
    :inherited-members:
    :show-inheritance:

Cache Backends
--------------
.. Sources for this sub-package will be autogenerated by sphinx-apidoc

.. toctree::

    modules/requests_cache.backends
