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

docs build fail on Sphinx v3.2.1 #1912

Closed
aaronmarkham opened this issue Sep 22, 2020 · 3 comments
Closed

docs build fail on Sphinx v3.2.1 #1912

aaronmarkham opened this issue Sep 22, 2020 · 3 comments

Comments

@aaronmarkham
Copy link
Member

Describe the bug

Warning, treated as error:
/home/ubuntu/anaconda3/envs/sagemaker/lib/python3.7/site-packages/sagemaker/amazon/linear_learner.py:docstring of sagemaker.LinearLearner:184:Field list ends without a blank line; unexpected unindent.

To reproduce
Setup an env w/ the latest Sphinx (3.2.1) and build the docs.

@icywang86rui
Copy link
Contributor

There seem to be a bug in Sphinx 3.2.1 that causes this - sphinx-doc/sphinx#8190
It should be fixed in 3.3.

@metrizable
Copy link
Contributor

This is also a little surprising, given that the sphinx tox target creates an isolated environment and installs its requirements, including specifying sphinx==3.1.1.

@aaronmarkham Can you describe how you are building the docs? Is it being done outside of a tox env?

@ajaykarpur ajaykarpur added the bug label Oct 7, 2020
@icywang86rui
Copy link
Contributor

It seems like there is nothing actionable here for us other than waiting for 3.3 to be released. Resolving. @aaronmarkham feel free to reopen if you need to upgrade to v3.2.1 now.

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

5 participants