Skip to content

gh-116622: Complete Android documentation#124259

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.

Sign up for GitHub

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

Jump to bottom
Merged
AA-Turner merged 15 commits into from
Sep 23, 2024
Merged

gh-116622: Complete Android documentation #124259

AA-Turner merged 15 commits into from
Sep 23, 2024

Conversation

@mhsmith
Copy link
Member

@mhsmithmhsmith commented Sep 20, 2024•
edited
Loading

The Android x86_64 buildbot is not yet up and running, so the statement that "Android is now a PEP 11 supported platform" is not quite ready to be merged, but I'd like to get an early review.

Summary:

  • Add an Android page to the "Setup and Usage" section.
  • Generalize the "Notes on availability" section to cover both iOS and Android.
  • Add "availability" markers to the modules and functions not supported on Android.

📚 Documentation preview 📚: https://cpython-previews--124259.org.readthedocs.build/

@bedevere-appbedevere-appbot mentioned this pull request Sep 20, 2024
Closed
@mhsmithmhsmith added the needs backport to 3.13 bugs and security fixes label Sep 20, 2024
@mhsmithmhsmith mentioned this pull request Sep 20, 2024
Merged
6 tasks
freakboy3742
freakboy3742 approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@freakboy3742freakboy3742 left a comment

Choose a reason for hiding this comment

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

This all looks good to me from a technical perspective; I'd like someone with more of a documentation eye (@hugovk?) to weigh in on any of the markup and layout aspects.

serhiy-storchaka
serhiy-storchaka approved these changes Sep 22, 2024
View reviewed changes
Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

I am not expert in Android, WASM or iOS, but this LGTM.

Doc/using/android.rst

* `Briefcase <https://briefcase.readthedocs.io>`__, from the BeeWare project
* `Buildozer <https://buildozer.readthedocs.io>`__, from the Kivy project
* `Chaquopy <https://chaquo.com/chaquopy>`__
Copy link
Member

@serhiy-storchakaserhiy-storchakaSep 22, 2024

Choose a reason for hiding this comment

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

You are affiliated with this, right? I do not think there is a problem here, taking into account open-sourcing Chaquopy and your contribution in CPython.

Copy link
Contributor

@freakboy3742freakboy3742Sep 23, 2024

Choose a reason for hiding this comment

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

Correct - Malcolm is the founder of Chaquopy.

Copy link
MemberAuthor

@mhsmithmhsmithSep 23, 2024

Choose a reason for hiding this comment

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

I've expanded this list to include all the production-quality Python-on-Android tools that I'm aware of.

AA-Turner
AA-Turner reviewed Sep 23, 2024
View reviewed changes
Copy link
Member

@AA-TurnerAA-Turner left a comment

Choose a reason for hiding this comment

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

Two quick comments:

@AA-TurnerAA-Turner requested review from AA-Turner and removed request for corona10, erlend-aasland and pradyunsgSeptember 23, 2024 15:13
freakboy3742
freakboy3742 reviewed Sep 23, 2024
View reviewed changes
freakboy3742
freakboy3742 reviewed Sep 23, 2024
View reviewed changes
freakboy3742
freakboy3742 reviewed Sep 23, 2024
View reviewed changes
@Yhg1s
Copy link
Member

Yhg1s commented Sep 23, 2024

Russel mentioned the android buildbot is now all set up and working, so is this ready to go in? :)

@freakboy3742
Copy link
Contributor

freakboy3742 commented Sep 23, 2024

@Yhg1s 2 Android buildbots are up and running:

The failures on the arm64 buildbot occur inconsistently; they would be been addressed by #123988, #124034, and #124035. Those 3 PRs alter the test suite and the Android test runner to make test conditions reproducible.

AA-Turner
AA-Turner reviewed Sep 23, 2024
View reviewed changes
@AA-TurnerAA-Turner enabled auto-merge (squash) September 23, 2024 22:55
@AA-TurnerAA-Turner added the docs Documentation in the Doc dir label Sep 23, 2024
@AA-TurnerAA-Turner merged commit e80dd30 into python:mainSep 23, 2024
@miss-islington-app
Copy link

miss-islington-appbot commented Sep 23, 2024

Thanks @mhsmith for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 23, 2024
@mhsmith@freakboy3742
@Yhg1s@AA-Turner@miss-islington
pythongh-116622: Complete Android documentation (pythonGH-124259)
4a3b708
(cherry picked from commit e80dd30) Co-authored-by: Malcolm Smith <smith@chaquo.com> Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: T. Wouters <thomas@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-appbot commented Sep 23, 2024

GH-124395 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Sep 23, 2024
Yhg1s added a commit that referenced this pull request Sep 24, 2024
@miss-islington@mhsmith
@freakboy3742@Yhg1s@AA-Turner
[3.13]gh-116622: Complete Android documentation (GH-124259) (#124395)
9a60a9d
gh-116622: Complete Android documentation (GH-124259) (cherry picked from commit e80dd30) Co-authored-by: Malcolm Smith <smith@chaquo.com> Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: T. Wouters <thomas@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@freakboy3742freakboy3742freakboy3742 approved these changes

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

@AA-TurnerAA-TurnerAA-Turner approved these changes

Assignees

No one assigned

Labels

docsDocumentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mhsmith@Yhg1s@freakboy3742@serhiy-storchaka@AA-Turner