summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2022-03-19 21:50:54 -0500
committerJordan Cook <jordan.cook@pioneer.com>2022-04-01 13:48:25 -0500
commit550fca5c604fa9635b19bb4ba10d444e36b30d05 (patch)
tree9a6882a7765db1e4201614d171bd3814ef39b39b /docs/conf.py
parent5a9a18c7bd1d14812fe6308992a193d4a1479a1e (diff)
downloadrequests-cache-550fca5c604fa9635b19bb4ba10d444e36b30d05.tar.gz
Update docs, doc dependencies, changelog, and contributors
Also: Restrict redis-py to <4.2, which breaks parameter forwarding on python 3.7 and 3.8
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py12
1 files changed, 3 insertions, 9 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 55b35a7..ed48e1b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,4 @@
# requests-cache documentation build configuration file
-import logging
import os
import sys
from os.path import abspath, dirname, join
@@ -15,7 +14,7 @@ TEMPLATE_DIR = join(PROJECT_DIR, 'docs', '_templates')
# General information about the project.
project = 'requests-cache'
-needs_sphinx = '3.0'
+needs_sphinx = '4.0'
master_doc = 'index'
source_suffix = ['.rst', '.md']
version = release = __version__
@@ -83,8 +82,8 @@ copybutton_prompt_is_regexp = True
# Generate labels in the format <page>:<section>
autosectionlabel_prefix_document = True
-# Use sphinx_autodoc_typehints extension instead of autodoc's built-in type hints
-autodoc_typehints = 'none'
+# Move type hint info to function description instead of signature
+autodoc_typehints = 'description'
always_document_param_types = True
# Use apidoc to auto-generate rst sources
@@ -137,13 +136,8 @@ def setup(app):
def patch_automodapi(app):
"""Monkey-patch the automodapi extension to exclude imported members:
https://github.com/astropy/sphinx-automodapi/blob/master/sphinx_automodapi/automodsumm.py#L135
-
- Also patches an unreleased fix for Sphinx 4 compatibility:
- https://github.com/astropy/sphinx-automodapi/pull/129
"""
from sphinx_automodapi import automodsumm
- from sphinx_automodapi.automodsumm import Automodsumm
from sphinx_automodapi.utils import find_mod_objs
automodsumm.find_mod_objs = lambda *args: find_mod_objs(args[0], onlylocals=True)
- Automodsumm.warn = lambda *args: logging.getLogger('sphinx_automodapi').warn(*args)