Sphinx - quick lookup

Hello,
I seem to be having issue with quick documentation lookup when docstring format is set to reStructuredText. The internal help says that in this case, quick-lookup is generated by Sphinx. However, the generated text is quite chaotic and not parsed at all:
qlookup.jpg

I would expect output more similar to the Epytext option (parameters grouped together with their types, etc.):
qlookup-epytext.jpg


I have setup the Sphinx working directory to the one created by sphinx-quickstart. I've tried to create ClassName.rst file with autoclass directive, but to no avail.

Have I missed some configuration or is this the expected result when using reStructuredText docstrings?

Thank you,
Pavel
7 comments
Comment actions Permalink
Do you have a Python 2 interpreter configured in your project? Sphinx won't run if you only have a Python 3 interpreter configured.
0
Comment actions Permalink
Yes, Python 2.7.2 interpreter is configured (and used, so I would assume it's configured correctly).
0
Comment actions Permalink
Any more recommendations that could resolve the problem? I've walked through entire help file on this subject and cannot get it working.
0
Comment actions Permalink
Is the problem only in strings alignment? Anyway feel free to report a bug to http://youtrack.jetbrains.com/issues/PY. Please be more specific about problems with formatting.
0
Comment actions Permalink
I'm not sure if it's a bug or just a misconfiguration on my part.

What I see as the problem is that parameters, exceptions etc are not grouped together and their expected types are not displayed with them, but separately. So, on the quick look, you do not get a nice list of parameters like when using Epytext.

The difference is visible on the images - with Epytext, you get nicely divided parameters, exceptions, return values - easily readable. With reStructuredText, the text is just taken as-is and bold emphasis is added.

If you can confirm this is not intended, I will happily submit a bug. Right now, I don't know if it's not just a configuration problem.
0
Comment actions Permalink
I've created a bug report for this issue: http://youtrack.jetbrains.com/issue/PY-7792.
0
Comment actions Permalink
Thank you!
0

Please sign in to leave a comment.