Skip to content

correct python version for RTD #40

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

Merged
merged 2 commits into from
Jan 31, 2022
Merged

Conversation

askpatrickw
Copy link
Contributor

fixes #39

@askpatrickw askpatrickw self-assigned this Jan 28, 2022
@dhalbert
Copy link
Contributor

Let's figure out if we can avoid doing this in some way, because we changed a lot of libraries, and it would be better not to have to update this each time we want to bump versions.

@askpatrickw askpatrickw requested a review from a team January 28, 2022 00:16
@FoamyGuy
Copy link
Contributor

The RTD error page indicates some other possible versions:

including 3. Perhaps that would behave as wanted 3.x to?
image

@dhalbert
Copy link
Contributor

readthedocs/readthedocs.org#7814 says it is now possible with readthedocs/readthedocs.org#8453. "Docs to be updated".

@dhalbert
Copy link
Contributor

https://docs.readthedocs.io/en/stable/config-file/v2.html#python-version says python.version is deprecated, and to use build.tools.python (https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python), where you can specify "3" as the version.

Not "3.x", boo hoo. But we'd change to

build:
  tools:
    python: "3"

anyway: https://docs.readthedocs.io/en/stable/config-file/v2.html#build

Could you try that? Thanks.

Copy link
Contributor

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see posts

@askpatrickw
Copy link
Contributor Author

OK, this builds, I setup a test RTD.

https://test-azureiot.readthedocs.io/en/rtd-python-ver/api.html

It is worth mentioning, that the OS setting is also required and the only allowed value is that one specific Ubuntu version. At some point, that's going to require touching all the repos I bet. :-/

Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, matches recent change merged in cookiecutter repo.

@FoamyGuy FoamyGuy merged commit f5ace81 into adafruit:main Jan 31, 2022
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Jan 31, 2022
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

Successfully merging this pull request may close these issues.

Doc Build failing due to non-specific python version in readthedocs.yaml
3 participants