Make Python parameters types hyperlinks in the doc strings.

It is very useful to be able to click on the parameter types in a function
documentation to go to this parameter description, so always use hyperlink
markup for the parameters of class types, even if not all of them are
necessarily documented -- Sphinx doesn't seem to complain about links to
unknown classes.
This commit is contained in:
Vadim Zeitlin 2014-08-05 16:21:09 +02:00
commit bb01e06a6a
2 changed files with 22 additions and 8 deletions

View file

@ -71,7 +71,7 @@ commentVerifier.check(doxygen_basic_translate.function7.__doc__,
"""
Test for a parameter with difficult type
(mostly for python)
:type a: Shape
:type a: :py:class:`Shape`
:param a: Very strange param
"""
)