Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Help" pane not rendering google-style docstring well #10925

Open
jsh9 opened this issue Dec 4, 2019 · 2 comments
Open

"Help" pane not rendering google-style docstring well #10925

jsh9 opened this issue Dec 4, 2019 · 2 comments

Comments

@jsh9
Copy link
Contributor

jsh9 commented Dec 4, 2019

You can reproduce this issue by installing pytorch (https://pytorch.org/get-started/locally/), load the doc of a pytorch class (for example, torch.nn.LSTM) into Spyder's "Help" pane, and compare it with Sphinx's rendering.

========================

Spyder's rendering:

(I use red lines to mark where formatting is incorrect.)

image

===========================

Sphinx's rendering:
https://pytorch.org/docs/stable/nn.html?highlight=lstm#torch.nn.LSTM
(It will take a few seconds to load this page)

@ccordoba12
Copy link
Member

We'll take a look at this for Spyder 5.

@grlee77
Copy link

grlee77 commented Feb 11, 2020

linking #2046 as a related issue

@goanpeca goanpeca removed this from the future milestone Feb 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants