diff options
Diffstat (limited to 'doc/build/conf.py')
| -rw-r--r-- | doc/build/conf.py | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/build/conf.py b/doc/build/conf.py index 46fd6147f..7f47d7540 100644 --- a/doc/build/conf.py +++ b/doc/build/conf.py @@ -28,7 +28,7 @@ os.environ["DISABLE_SQLALCHEMY_CEXT_RUNTIME"] = "true" # -- General configuration -------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "3.5.0" +needs_sphinx = "5.0.1" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -112,7 +112,15 @@ changelog_render_changeset = "https://www.sqlalchemy.org/trac/changeset/%s" exclude_patterns = ["build", "**/unreleased*/*", "**/*_include.rst"] autodoc_class_signature = "separated" -autodoc_typehints_format = "short" + + +# to use this, we need: +# 1. fix sphinx-paramlinks to work with "description" typing +# 2. we need a huge autodoc_type_aliases map as we have extensive type aliasing +# present, and typing is largely not very legible w/ the aliases +# autodoc_typehints = "description" +# autodoc_typehints_format = "short" +# autodoc_typehints_description_target = "documented" # zzzeeksphinx makes these conversions when it is rendering the # docstrings classes, methods, and functions within the scope of |