We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 4fb63ab commit 7fde08bCopy full SHA for 7fde08b
README.rst
@@ -64,6 +64,17 @@ Only arguments that have an existing ``:param:`` directive in the docstring get
64
This extension does not currently have any configuration options.
65
66
67
+Compatibility with sphinx.ext.napoleon
68
+--------------------------------------
69
+
70
+To use `sphinx.ext.napoleon`_ with sphinx-autodoc-typehints, make sure you load
71
+`sphinx.ext.napoleon`_ first, **before** sphinx-autodoc-typehints. See `Issue 15`_ on the issue
72
+tracker for more information.
73
74
+.. _sphinx.ext.napoleon: http://www.sphinx-doc.org/en/stable/ext/napoleon.html
75
+.. _Issue 15: https://github.com/agronholm/sphinx-autodoc-typehints/issues/15
76
77
78
Project links
79
-------------
80
0 commit comments