summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-04-18 21:46:08 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-04-19 16:45:34 -0500
commitf0916900e11778f9ff0a33b148edbf2f51f6f600 (patch)
tree36627a6f9c46657bac58d28d2c17ff311c1d679c /docs/conf.py
parent714814d0c23271fb357e9ee094e8754ef9818029 (diff)
downloadrequests-cache-f0916900e11778f9ff0a33b148edbf2f51f6f600.tar.gz
Allow passing any valid backend connection kwargs via BaseCache
* Pass `**kwargs` to backend storage classes, split out any that are valid for the backend-specific connection function/class, and pass them to the connection * Add intersphinx links to docs for dependencies * Update and format some more backend class docstrings * Remove 'Unrecognized keyword arguments' warning from `BaseStorage` * Turn `warnings.warn` about using secret keys into a `logging.warning` (due to complaints about too many messages)
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 6d92cad..68eeb16 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -26,6 +26,7 @@ templates_path = ['_templates']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
+ 'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
@@ -40,10 +41,17 @@ exclude_patterns = ['_build', 'modules/requests_cache.rst']
# Enable automatic links to other projects' Sphinx docs
intersphinx_mapping = {
+ 'boto3': ('https://boto3.amazonaws.com/v1/documentation/api/latest/', None),
+ 'botocore': ('http://botocore.readthedocs.io/en/latest/', None),
+ 'pymongo': ('https://pymongo.readthedocs.io/en/stable/', None),
'python': ('https://docs.python.org/3', None),
+ 'redis': ('https://redis-py.readthedocs.io/en/stable/', None),
'requests': ('https://docs.python-requests.org/en/master/', None),
'urllib3': ('https://urllib3.readthedocs.io/en/latest/', None),
}
+extlinks = {
+ 'boto3': ('https://boto3.amazonaws.com/v1/documentation/api/latest/reference/%s', None),
+}
# Enable Google-style docstrings
napoleon_google_docstring = True