PyCharm Docstring :func: and :meth: not working

Asked Mar 15 '21 at 10:35

Active Mar 15 '21 at 16:03

Viewed 352 times

I am writing a documentation in my project's code but the inline link to a function/method doesn't work. It simply doesn't show up as expected when I use CTRL + Q:

EDIT:

Code:

class Editor:

    def picture(self):
        """ The same as :func:`pictures` """
        pass

    def pictures(self):
        pass

edited Mar 15 '21 at 16:03

LazyOne

158,824
45
388
391

asked Mar 15 '21 at 10:35

Stephirio

Does ``:func:`~.pictures` `` or ``:func:`.pictures` `` work? – MisterMiyagi Mar 15 '21 at 15:40
Please [edit] the question to also provide the code as text. This allows others to try the code/solution without having to recreate an example. – MisterMiyagi Mar 15 '21 at 15:42
What's the name of your class? If it's `pictures`, maybe it can't figure out which thing by the name of `pictures` you're referring to. – Kevin Mar 15 '21 at 15:52
@MisterMiyagi i edited it, sorry I didn't put it before. By the way, none of the suggested snippets work – Stephirio Mar 15 '21 at 15:58
@Kevin the name of the class is Editor – Stephirio Mar 15 '21 at 16:00
Come to think of it: What makes you think this should work in the first place? The ``:func:`` references are part of Sphinx, not regular ReST. – MisterMiyagi Mar 15 '21 at 16:03
1

But as far as I know Sphinx tags work in PyCharm – Stephirio Mar 15 '21 at 16:06

PyCharm Docstring :func: and :meth: not working

0 Answers0