Spyder: Missing space when rendering NumPy docstrings

Created on 23 Jul 2019  路  7Comments  路  Source: spyder-ide/spyder

In NumPy-style docs such as this snippet below:

----------
some_param : type of this parameter
    Explanation about the parameter

Spyder's help renders the type of the parameter without any spacing from the name. Attached is a screenshot highlighting this:
spyder_format

Sphinx itself adds that extra separating space, as can be seen in e.g. the official numpy docs:
https://docs.scipy.org/doc/numpy-1.15.0/reference/generated/numpy.arange.html

Help 2-Major Bug v4.1.0

All 7 comments

That's a Sphinx problem and it changes from version to version.

What's your Sphinx version?

@ccordoba12 : it's Sphinx 2.1.2 (latest stable version). If I pick some random package and build html docs through Sphinx with the alabaster theme, they don't look like they're missing a space.

Roll back to sphinx 1.8.5 I raised this issue a while ago https://github.com/spyder-ide/spyder/issues/created_by/Dan-Patterson

@Dan-Patterson, your link above doesn't show any issues.

https://github.com/spyder-ide/spyder/issues/9527 missed the link... issue 9527. I have also seen references to pinning to sphinx 1.8.5 with other packages, but I don't have a list.

Thanks! I closed that issue in favor of this one because this has a more detailed explanation of the problem.

@dalthviz, please take care of this one as soon as you can. We need it for @juanis2112's work on improving our docs.

Was this page helpful?
0 / 5 - 0 ratings