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

Sphinx rendering of parameters section changed? #16585

Closed
sylee957 opened this issue Apr 7, 2019 · 3 comments · Fixed by #17385
Closed

Sphinx rendering of parameters section changed? #16585

sylee957 opened this issue Apr 7, 2019 · 3 comments · Fixed by #17385

Comments

@sylee957
Copy link
Member

sylee957 commented Apr 7, 2019

https://docs.sympy.org/latest/modules/discrete.html#sympy.discrete.transforms.fft
https://docs.sympy.org/dev/modules/discrete.html#sympy.discrete.transforms.fft

image

image

I see the indentation changed, and it looks more disorganized in later one

@moorepants
Copy link
Member

Sphinx 2.0 recently came out. I noticed quite a few backwards incompatibilities in the changelog, maybe this is related.

@sylee957 sylee957 added this to the SymPy 1.5 milestone Apr 9, 2019
@sylee957
Copy link
Member Author

sylee957 commented Aug 1, 2019

As far as I had tried with the maintained numpydoc extension, the problem still remains, and it is a dead end.
I haven't tried with napoleon yet.

@sylee957
Copy link
Member Author

sylee957 commented Aug 1, 2019

Okay, I've also tried with napoleon but things are not working too.

It may possibly be broken from the sphinx side (e.g. issue sphinx-doc/sphinx#6262)
I see the parameters sections are technically rendered as field lists, and it seems like we to change the style to something other than classic, or patch our CSS theme to get it working

I've applied the one sphinx-doc/sphinx#6266 manually, and things may not be identical as previous, but seems like working.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants