Use sphinx-autodoc-typehints for promoting type hints to Sphinx docs.

python-jsonschema · Jun 2, 2022 · af47da8 · af47da8
1 parent 8d6e113
commit af47da8
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 19 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,6 +25,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
     "sphinxcontrib.spelling",
     "jsonschema_role",
 ]

diff --git a/docs/requirements.in b/docs/requirements.in
@@ -2,4 +2,5 @@ file:.#egg=jsonschema
 furo
 lxml
 sphinx
+sphinx-autodoc-typehints
 sphinxcontrib-spelling
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -8,55 +8,58 @@ alabaster==0.7.12
     # via sphinx
 attrs==21.4.0
     # via jsonschema
-babel==2.9.1
+babel==2.10.1
     # via sphinx
-beautifulsoup4==4.10.0
+beautifulsoup4==4.11.1
     # via furo
-certifi==2021.10.8
+certifi==2022.5.18.1
     # via requests
-charset-normalizer==2.0.10
+charset-normalizer==2.0.12
     # via requests
 docutils==0.17.1
     # via sphinx
-furo==2022.1.2
+furo==2022.4.7
     # via -r docs/requirements.in
 idna==3.3
     # via requests
 imagesize==1.3.0
     # via sphinx
-jinja2==3.0.3
+jinja2==3.1.2
     # via sphinx
 file:.#egg=jsonschema
     # via -r docs/requirements.in
-lxml==4.7.1
+lxml==4.9.0
     # via -r docs/requirements.in
-markupsafe==2.0.1
+markupsafe==2.1.1
     # via jinja2
 packaging==21.3
     # via sphinx
 pyenchant==3.2.2
     # via sphinxcontrib-spelling
-pygments==2.11.2
+pygments==2.12.0
     # via
     #   furo
     #   sphinx
-pyparsing==3.0.6
+pyparsing==3.0.9
     # via packaging
-pyrsistent==0.18.0
+pyrsistent==0.18.1
     # via jsonschema
-pytz==2021.3
+pytz==2022.1
     # via babel
 requests==2.27.1
     # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
-soupsieve==2.3.1
+soupsieve==2.3.2.post1
     # via beautifulsoup4
-sphinx==4.3.2
+sphinx==4.5.0
     # via
     #   -r docs/requirements.in
     #   furo
+    #   sphinx-autodoc-typehints
     #   sphinxcontrib-spelling
+sphinx-autodoc-typehints==1.18.1
+    # via -r docs/requirements.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
@@ -69,10 +72,7 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
-sphinxcontrib-spelling==7.3.2
+sphinxcontrib-spelling==7.5.0
     # via -r docs/requirements.in
-urllib3==1.26.7
+urllib3==1.26.9
     # via requests
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools