From 5a0bdbf5dec252cfa226eedccb863c3c04d731ce Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Thu, 24 Aug 2023 21:42:31 +0200 Subject: [PATCH] limit sphinx version and enable autotoc typehints sphinx 7 introduces an issue with circular imports --- doc/conf.py | 1 + doc/requirements.txt | 1 + tox.ini | 3 ++- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 0c07a38..4381304 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -34,6 +34,7 @@ root = os.path.relpath(os.path.join(os.path.dirname(__file__), "..")) # ones. extensions = [ "sphinx.ext.autodoc", + "sphinx_autodoc_typehints", "sphinx.ext.doctest", "sphinx.ext.todo", "sphinx.ext.coverage", diff --git a/doc/requirements.txt b/doc/requirements.txt index 25808d4..694ba21 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -11,4 +11,5 @@ python-barcode>=0.11.0,<1 importlib-metadata importlib_resources sphinxcontrib.datatemplates +sphinx-autodoc-typehints pycups diff --git a/tox.ini b/tox.ini index c990d90..6543cbe 100644 --- a/tox.ini +++ b/tox.ini @@ -30,11 +30,12 @@ setenv = PY_IGNORE_IMPORTMISMATCH=1 [testenv:docs] basepython = python changedir = doc -deps = sphinx>=3.0.0 +deps = sphinx>=3.0.0,<7 setuptools_scm python-barcode sphinxcontrib-spelling>=7.2.0 sphinxcontrib.datatemplates + sphinx-autodoc-typehints sphinx_rtd_theme pycups commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html