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.

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

installation documentation could be refreshed #695

Closed
cmacdonald opened this issue Nov 8, 2023 · 3 comments
Closed

installation documentation could be refreshed #695

cmacdonald opened this issue Nov 8, 2023 · 3 comments

Comments

@cmacdonald
Copy link
Contributor

https://pyjnius.readthedocs.io/en/latest/installation.html talks a lot about installing Cython etc, which isnt really necessary. You can pip install the binaries. That content should move to a building page, and make the installation much easier.
@misl6
Copy link
Member

misl6 commented Nov 10, 2023

Agree.

People can get confused about all that stuff. (I mean, building from source is something we should document, but like the kivy/kivy repo, so separately).

I guess the new structure could be something like this:

  • Installation
    • Prerequisites (Python, Java)
    • Install pre-build artifact (easy) (via pip install pyjnius)
    • Build from source
      • Build from source Windows
      • Build from source Linux
      • Build from source macOS
      • Build from source Android (needed?)

@cmacdonald
Copy link
Contributor Author

Seems reasonable.

Was wondering about separating installation to another page tbh, but if it's clear that it's not normally needed, then it's already an improvement.

cmacdonald added a commit to cmacdonald/pyjnius that referenced this issue Nov 20, 2023
@cmacdonald
documentation changes for kivy#695
396e902
@cmacdonald cmacdonald mentioned this issue Nov 20, 2023
Merged
misl6 added a commit that referenced this issue Nov 24, 2023
@cmacdonald @misl6
Refresh installation and build docs (#700)
a2c799f 
* documentation changes for #695

* addressing review comments, and a clarification in packaging

* Update docs/source/installation.rst

Co-authored-by: Mirko Galimberti <[email protected]>

* addressing feedback

* fix Java location

* much simplified building instructions

* addressed comments

---------

Co-authored-by: Mirko Galimberti <[email protected]>
@misl6
Copy link
Member

misl6 commented Nov 24, 2023

Fixed via #700

@misl6 misl6 closed this as completed Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cmacdonald @misl6