Skip to content

Commit 7fde08b

Browse files
committed
Added instructions for using sphinx.ext.napoleon with autodoc-typehints
Fixes #15.
1 parent 4fb63ab commit 7fde08b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

+11
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@ Only arguments that have an existing ``:param:`` directive in the docstring get
6464
This extension does not currently have any configuration options.
6565

6666

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+
6778
Project links
6879
-------------
6980

0 commit comments

Comments
 (0)