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

Require Sphinx 1.8.5 #49

Open
jxu opened this issue Jul 2, 2019 · 4 comments
Open

Require Sphinx 1.8.5 #49

jxu opened this issue Jul 2, 2019 · 4 comments

Comments

@jxu
Copy link
Contributor

jxu commented Jul 2, 2019

Bug in Sphinx or RTD theme causes docs to appear wrong.

readthedocs/sphinx_rtd_theme#750

Screenshot from 2019-07-02 01-45-55

Originally posted by @jxu in #48 (comment)

@llllllllll
Copy link
Owner

ah, we should ad an extra target like dev (https://github.com/llllllllll/slider/blob/master/setup.py#L39) for docs and pin the version of sphinx and sphinx rtd

@jxu
Copy link
Contributor Author

jxu commented Jul 13, 2019

actually I tried sphinx==1.8.5 and sphinx-rtd-theme==0.4.2 and still broken for me.
default theme works fine for me so it's a sphinx-rtd-theme issue

@jxu
Copy link
Contributor Author

jxu commented Aug 26, 2019

For now can we change the theme?

@llllllllll
Copy link
Owner

Yeah, I like the RTD theme a lot because I mostly consume docs on RTD, but I would be fine changing it to something else that looks nice if there are real issues with it. If find a theme that looks good, I would switch. Maybe we just need to update the numpydoc package which (at least at one time, it may just be part of sphinx now) parsed the numpy-style docstrings.

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

No branches or pull requests

2 participants