Improve docs wrt type hints and models (#109)

felix-hilden · Jul 19, 2021 · ef6853e · ef6853e
1 parent 11d7268
commit ef6853e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -15,7 +15,6 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.extlinks',
     'sphinx.ext.napoleon',
-    'sphinx_autodoc_typehints',
     'sphinx_rtd_theme',
 ]
 
@@ -26,6 +25,9 @@
     'members': True,
     'show-inheritance': True,
 }
+autodoc_typehints = 'description'
+autoclass_content = 'both'
+python_use_unqualified_type_names = True
 
 html_theme = 'sphinx_rtd_theme'
 extlinks = {

diff --git a/docs/src/release_notes.rst b/docs/src/release_notes.rst
@@ -12,6 +12,10 @@ Changed
 - Add fields to :class:`Request` and change their meaning to be in line with
   the new HTTPX interface (:issue:`250`)
 
+Added
+*****
+- Improved documentation for type hints and response models (:issue:`109`)
+
 3.7.1 (2021-05-04)
 ------------------
 Fixed

diff --git a/setup.py b/setup.py
@@ -35,9 +35,8 @@
 
 extras_require = {
     'docs': [
-        'sphinx~=3.1',
+        'sphinx~=4.0',
         'sphinx-rtd-theme',
-        'sphinx-autodoc-typehints~=1.11'
     ],
     'tests': [
         'coverage',