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

Refresh installation and build docs #700

Merged
merged 7 commits into from
Nov 24, 2023
Merged

Conversation

cmacdonald
Copy link
Contributor

This addresses the changes discussed in #695.

Copy link
Contributor

@Julian-O Julian-O left a comment

Choose a reason for hiding this comment

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

  • File name contains typo: buildLing.rst

docs/source/buildling.rst Outdated Show resolved Hide resolved
@cmacdonald
Copy link
Contributor Author

Thanks for the review @Julian-O. Feedback addressed.

Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

Hi @cmacdonald !

I've left some comments. Some of them are not really tied to your PR, but makes sense to update what looks outdated, while we're moving things.

Let me know what you think about it.

docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/installation.rst Outdated Show resolved Hide resolved
docs/source/quickstart.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
Copy link
Contributor Author

@cmacdonald cmacdonald left a comment

Choose a reason for hiding this comment

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

Hi @misl6. Thanks for your review. I addressed those changes.

I read over the building.rst in more details, adding my own thoughts about duplicated material and possible better structuring, and other thoughts about the material.

docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
docs/source/building.rst Outdated Show resolved Hide resolved
@cmacdonald
Copy link
Contributor Author

cmacdonald commented Nov 23, 2023

Thanks @misl6. I vastly simplified the building page. Screenshot here for ease of reference:

image

Perhaps the Visual Studio link could be inline like the rest?

Did I remove anything important?

@Julian-O
Copy link
Contributor

Quick style review of screenshot:

  • Title has inconsistent capitalisation.
  • Java Development Kit - make the link apply to the whole phrase, not just Java.
  • Java Development Kit - add "(JDK)" to introduce the abbreviation that is used below.
  • "the building requirements" -> "the build requirements"
  • Gnu Compiler Collection - add a link to https://gcc.gnu.org/ - consider adding the name of the apt-get package.
  • Yes, inline the Microsoft downloads link
  • pip install . - I never know whether to specify that you need to download the code, and change into the directory with setup.py before running this - I mean, the sort of people who want to do this know that, right? right??
  • "This installs Cython" - add a link to what Cython is
  • "shell environment variable" - remove the word "shell" which is a Unix-specific term.

@cmacdonald
Copy link
Contributor Author

Revised version:
image

"shell environment variable" - remove the word "shell" which is a Unix-specific term.

I currently left this, as the previous sentence talks about Python build environments.

@Julian-O
Copy link
Contributor

"shell environment variable" - remove the word "shell" which is a Unix-specific term.

I currently left this, as the previous sentence talks about Python build environments.

I don't care enough to suggest a further change, but both Windows and Linux build environments have "environment variables", but only Linux (and Unix) use the term "shell" so when you talk about "shell environment variables" being needed on Windows, it doesn't match up.

Copy link
Member

@misl6 misl6 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you!

Agree with @Julian-O regarding env variables, but I also do not want to lock this PR progress. Feel free to address it separately.

@misl6 misl6 changed the title documentation changes for #695 Refresh installation and build docs Nov 24, 2023
@misl6 misl6 merged commit a2c799f into kivy:master Nov 24, 2023
208 checks passed
@cmacdonald cmacdonald deleted the doc_improvements branch November 24, 2023 18:02
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.

3 participants