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

Show syntax error with Python 3.6 #2581

Closed
eirenik0 opened this issue Jan 8, 2017 · 20 comments
Closed

Show syntax error with Python 3.6 #2581

eirenik0 opened this issue Jan 8, 2017 · 20 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@eirenik0
Copy link

eirenik0 commented Jan 8, 2017

Details

I'm using Python 3.6 f-string and variable annotations.

Expected Result

Docs should be build

Actual Result

Syntax error

@pcattori
Copy link

Same thing happening to me:

@dirn
Copy link
Contributor

dirn commented Jan 28, 2017

As mentioned in #1990, RTD currently only supports Python 3.4 for CPython 3.x projects. Any syntax (e.g., async/await, f-strings) or modules (e.g., typing) introduced since then will cause autodoc to fail.

@humitos humitos added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Feb 23, 2017
@ericholscher
Copy link
Member

We have a beta builder that has 3.6, which you can sign up for here: https://docs.google.com/forms/d/e/1FAIpQLSfFufPgFiPFNjGTr0c8ErNY92h_S4QmF1EVrsMOGD4VofWDdg/viewform?c=0&w=1

@achimnol
Copy link

achimnol commented Aug 8, 2017

I have sent the beta application via the above form twice during last a few days, but haven't gotten any reply yet.
Is the beta participation program still active?

@chrizzFTD
Copy link

I've submitted the beta application twice since early April this year but didn't get an answer; was hoping the feature would start running in production because of that, but it has not. I've moved to github pages in the meantime.

I got one project running on that beta (application submitted in February) and it runs great!

@chrizzFTD
Copy link

@achimnol have you tried the alternative mentioned in issue 2584 using conda? I've tried it and it works properly; setup is a bit more verbose but completely worth it! On that issue they reference the poliastro project as an example.

@numberoverzero
Copy link

@ericholscher I've submitted that form a few times for the bloop project but my builds are still failing: https://readthedocs.org/projects/bloop/builds/5995227/

Anything else I can do to opt into the program? I really don't want to resort to conda for this.

@mathiasbrito
Copy link

Any news on this issue? Also requested access to the Beta and did not get it. My project is all python 3.6 and I get syntax errors with type annotation.

@ericholscher
Copy link
Member

We have a PR open that will let users configure this themselves: #3339 -- it has one outstanding issue, and then should be merged in the next week or so.

@liiight
Copy link

liiight commented Jan 2, 2018

so if i want to use use python 3.6 ill have to dockerize my project? I'm sorry if I misunderstood how that PR solves the 3.6 issue...

@dirn
Copy link
Contributor

dirn commented Jan 2, 2018

RTD runs the builders in Docker containers. The PR provides more control over which image is used.

@liiight
Copy link

liiight commented Jan 2, 2018

I see. Thanks for the explanation, looking forward for the implemented solution

@goranvrbaski
Copy link

When can we expect this solution to be implemented?

@ericholscher
Copy link
Member

ericholscher commented Jan 8, 2018

@ericholscher
Copy link
Member

It's a new feature, so please let us know if it isn't working for some case.

@gasparka
Copy link

gasparka commented Jan 9, 2018

I ran into pypa/pip#4216 while installing 'sphinxcontrib.fulltoc' as extra requirement... updating the pip should fix this.

Otherwise it works, thanks :)

@liiight
Copy link

liiight commented Jan 9, 2018

Well, the build runs now and it doesn't fail but for some reason I don't see autodoc stuff (even though it looks fine locally when i make html via sphinx).
I'm not sure if it's a config issue on my part (probably) or a real issue.

docs: http://notifiers.readthedocs.io/en/latest/API.html
source: https://github.com/liiight/notifiers/blob/develop/source/API.rst

I'd appreciate the help and I apoligize in advance if I'm hijacking the issue. This is my first RTD project...

@gasparka
Copy link

gasparka commented Jan 9, 2018

@liiight i use pip_install: true and autodoc works.

@liiight
Copy link

liiight commented Jan 9, 2018

Thanks @gasparka! That did the trick! python 3.6 works great here too 😄

@RichardLitt
Copy link
Member

That's two confirmations. I am going to call this as closed. If anyone has an issue, let's reopen. Thanks everyone!

costrouc added a commit to costrouc/python-package-template that referenced this issue May 29, 2018
dazza-codes pushed a commit to dazza-codes/aio-aws that referenced this issue Nov 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests