From a3c2777fea984c646246b9ed324186bba1fee8c6 Mon Sep 17 00:00:00 2001 From: "Adam J. Stewart" Date: Sat, 31 Aug 2024 13:01:11 +0200 Subject: [PATCH] Undo sphinx req changes --- docs/conf.py | 5 ++--- pyproject.toml | 5 +++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 037b9016b1..4078970c2e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,8 +50,8 @@ # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build'] -# Sphinx 4.4+ required for autodoc_typehints_format -needs_sphinx = '4.4' +# Sphinx 4.0+ required for autodoc_typehints_description_traget +needs_sphinx = '4.0' nitpicky = True nitpick_ignore = [ @@ -105,7 +105,6 @@ autodoc_member_order = 'bysource' autodoc_typehints = 'description' autodoc_typehints_description_target = 'documented' -autodoc_typehints_format = 'short' # sphinx.ext.intersphinx intersphinx_mapping = { diff --git a/pyproject.toml b/pyproject.toml index a5486ab971..988c58d1d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -103,10 +103,10 @@ docs = [ "nbsphinx>=0.8.5", # release versions missing files, must install from master "pytorch-sphinx-theme", - # sphinx 4.4+ required for autodoc_typehints_format + # sphinx 4+ required for autodoc_typehints_description_target # sphinx 6+ is incompatible with pytorch-sphinx-theme # https://github.com/pytorch/pytorch_sphinx_theme/issues/175 - "sphinx>=4.4,<6", + "sphinx>=4,<6", ] style = [ # mypy 0.900+ required for pyproject.toml support @@ -233,6 +233,7 @@ filterwarnings = [ "ignore:ast.* is deprecated and will be removed in Python 3.14:DeprecationWarning:docstring_parser.attrdoc", # https://github.com/python/cpython/pull/102953 "ignore:Python 3.14 will, by default, filter extracted tar archives and reject files or modify their metadata:DeprecationWarning:torchgeo.datasets.utils", + "ignore:Python 3.14 will, by default, filter extracted tar archives and reject files or modify their metadata:DeprecationWarning:torchgeo.datasets.digital_typhoon", "ignore:Python 3.14 will, by default, filter extracted tar archives and reject files or modify their metadata:DeprecationWarning:torchvision.datasets.utils", # https://github.com/kornia/kornia/pull/2967 "ignore:`torch.cuda.amp.custom_fwd\\(args...\\)` is deprecated.:FutureWarning:kornia.feature.lightglue",