Make doc structure consistent and up-to-date #786

Julian-O · 2023-11-26T09:57:56Z

This is part of an effort to make the Kivy sibling projects' documentation
structure consistent and up-to-date.

Unrelated changes:

Readme Copy-edit. Reformat markdown table
RST added structure, including API page
Congrats, promoted from "beta" to "stable".
Fixed some (but not all) unrelated PEP8 changes

CHECKLIST

CONTRIBUTING.md
[x] If repo takes user contributions, is present
[x] In root dir (not .github dir)
[x] Refers to kivy/kivy Contribution Guidelines.
LICENSE
[x] If repo takes user contributions, is present.
[x] Acknowledges the range of years to 2023.
[x] Acknowledges Kivy Team and other contributors
[x] Mentions it is an MIT License.
CODE_OF_CONDUCT.md
[x] If repo takes user contributions or hosts discussions, is present.
[x] Refers to kivy/kivy CODE_OF_CONDUCT.md
CONTACT.md
[x] Refers to kivy/kivy CONTACT.md
FAQ.md
[NA] If repo is big enough for RST documentation, is present.
(RST documentation exists but is trivial)
README:
[x] Is a Markdown file.
[x] Describes the project.
[x] Describes its place in the Kivy sibling projects.
[x] If CONTRIBUTING exists, mentions it.
[x] If LICENSE exists, mentions it.
[x] If CODE_OF_CONDUCT exists, mentions it.
[x] Mentions kivy/kivy CONTACT.md
[NA] Uses Python syntax colouring for embedded Python code.
[x] Uses badges to display current status.
RST documentation, if present
[x] Describes the project.
[x] Describes its place in the Kivy sibling projects.
[x] Mentions LICENSE.
[x] Mentions CONTRIBUTING
[NA] Mentions FAQ
[x] conf.py mentioned Kivy Team and other contributors
- copyright, latex_documents, man_pages, texinfo documents
WORKFLOWS
[x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag.
[x] NO_RESPONSE uses latest script versions.
[x] SUPPORT.yml is present if the repo has a support tag.
[x] SUPPORT.yml refers to kivy/kivy CONTACT.md
setup.py/cfg, if present and on PyPI
[x] Supplies description to PyPI
[x] Supplies Python versions to PyPI
[x] Supplies Documentation, if any, to PyPI

This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. Unrelated changes: * Readme Copy-edit. Reformat markdown table * RST added structure, including API page * Congrats, promoted from "beta" to "stable" in setup classifiers CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [NA] If repo is big enough for RST documentation, is present. (RST documentation exists but is trivial) * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [NA] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to kivy/kivy CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI

Fixed some I am reasponsible for (setup and conf), and some I am not responsible for (space before line continuation) but did not fix all I wasn't responsible for.

Includes adding FAQ. This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Explains relationship to Kivy, if unclear. [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [x] If repo is big enough for RST documentation, is present. * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If Documentation exists, mention it. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status, including: [x] Backers [x] Sponsors [x] GitHub contributors [x] Contributor Covenant [x] PyPI Version [x] PyPI Python Version [x] Build/Test status [x] Displays all contributors to the repo. [x] Displays backers [x] Displays top sponsors. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions (Kivy/Kivy) Contact Us link. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [x] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to repo's CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI

misl6

Hi @Julian-O !

I've left some comments, let me know what you think about it.

misl6 · 2023-12-06T19:45:49Z

CONTACT.md

@@ -0,0 +1,8 @@
+# Contacting the Kivy Team
+
+Are you having trouble using the Kivy framework, or any of its related projects?


Maybe we should use the same phrasing used in https://github.com/kivy/pyjnius/blob/master/CONTACT.md ?

misl6 · 2023-12-06T19:50:54Z

README.md

+Plyer is a platform-independent Python API for accessing features
+of various hardware platforms, especially Android and iOS devices.


Suggested change

Plyer is a platform-independent Python API for accessing features

of various hardware platforms, especially Android and iOS devices.

Plyer is a platform-independent Python API for accessing features

of various platforms (Android, iOS, macOS, Linux and Windows).

Just trying to improve it for SEO.

Okay, but I have reworded to keep in the hardware part, because that is the element that unifies these APIs.

misl6 · 2023-12-06T19:53:09Z

README.md

- On iOS(kivy-ios), pyobjus is used
- On windows/mac/linux, commonly found libraries and programs will be used
+- On Android ([python-for-android](https://python-for-android.readthedocs.io/)), [PyJNIus](https://pypi.org/project/pyjnius/) is used.
+- On iOS ([kivy-ios](https://pypi.org/project/kivy-ios/)), [pyobjus](https://pypi.org/project/pyobjus/) is used.


Also on macOS pyobjus is used quite widely.

misl6 · 2023-12-06T19:57:31Z

docs/source/conf.py

@@ -43,7 +43,7 @@

 # General information about the project.
 project = u'Plyer'
-copyright = u'2013, Mathieu Virbel, Akshay Aurora, Gabriel Petier, Ben Rousch'
+copyright = u'2013-2024, Kivy Team and other contributors'


Suggested change

copyright = u'2013-2024, Kivy Team and other contributors'

copyright = u'2013-2023, Kivy Team and other contributors'

misl6 · 2023-12-06T19:59:30Z

docs/source/contact.rst

+
+If you are looking to contact the Kivy Team (who are responsible for managing the
+Plyer project), including looking for support, please see our
+`latest contact details <https://github.com/kivy/kivy/blob/master/CONTACT.md>`_.


Suggested change

`latest contact details <https://github.com/kivy/kivy/blob/master/CONTACT.md>`_.

`latest contact details <https://github.com/kivy/plyer/blob/master/CONTACT.md>`_.

misl6 · 2023-12-06T20:00:44Z

docs/source/index.rst

+Plyer is a platform-independent Python API for accessing features
+of various hardware platforms, especially Android and iOS devices.


Suggested change

Plyer is a platform-independent Python API for accessing features

of various hardware platforms, especially Android and iOS devices.

Plyer is a platform-independent Python API for accessing features

of various platforms (Android, iOS, macOS, Linux and Windows).

misl6 · 2023-12-06T20:01:22Z

docs/source/index.rst

+and is suitable for use with Kivy apps.
+
+Plyer is released and distributed under the terms of the MIT license. Our
+`latest license <https://github.com/kivy/kivy/blob/master/LICENSE>`_


Suggested change

`latest license <https://github.com/kivy/kivy/blob/master/LICENSE>`_

`latest license <https://github.com/kivy/plyer/blob/master/LICENSE>`_

misl6 · 2023-12-06T20:02:25Z

setup.py

@@ -56,7 +56,9 @@
 setup(
    name='plyer',
    version=plyer.__version__,
-    description='Platform-independent wrapper for platform-dependent APIs',
+    description='A platform-independent Python API for accessing features of '
+                'various hardware platforms, especially Android and iOS '


Maybe the same description (for SEO purposes) that I have suggested in README?

Was bitten by PEP's 79 versus 80 width. Decided to fix one more style-failure-that-wasn't-my-fault while I was here - redid the imports on garden.graph. (Bring on `black`!)

misl6

LGTM. Thank you!

* Make doc structure consistent and up-to-date This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. Unrelated changes: * Readme Copy-edit. Reformat markdown table * RST added structure, including API page * Congrats, promoted from "beta" to "stable" in setup classifiers CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [NA] If repo is big enough for RST documentation, is present. (RST documentation exists but is trivial) * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [NA] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to kivy/kivy CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI * PEP8 fixes Fixed some I am reasponsible for (setup and conf), and some I am not responsible for (space before line continuation) but did not fix all I wasn't responsible for. * Updated according to new checklist Includes adding FAQ. This is part of an effort to make the Kivy sibling projects' documentation structure consistent and up-to-date. CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Explains relationship to Kivy, if unclear. [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT.md * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [x] If repo is big enough for RST documentation, is present. * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If Documentation exists, mention it. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status, including: [x] Backers [x] Sponsors [x] GitHub contributors [x] Contributor Covenant [x] PyPI Version [x] PyPI Python Version [x] Build/Test status [x] Displays all contributors to the repo. [x] Displays backers [x] Displays top sponsors. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions (Kivy/Kivy) Contact Us link. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [x] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to repo's CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI * Review comments * PEP8 Was bitten by PEP's 79 versus 80 width. Decided to fix one more style-failure-that-wasn't-my-fault while I was here - redid the imports on garden.graph. (Bring on `black`!)

Julian-O added 3 commits November 26, 2023 20:23

PEP8 fixes

5b79359

Fixed some I am reasponsible for (setup and conf), and some I am not responsible for (space before line continuation) but did not fix all I wasn't responsible for.

Julian-O requested a review from misl6 December 6, 2023 13:02

misl6 requested changes Dec 6, 2023

View reviewed changes

Julian-O added 2 commits December 7, 2023 14:58

Review comments

d4ae048

PEP8

1b88b6c

Was bitten by PEP's 79 versus 80 width. Decided to fix one more style-failure-that-wasn't-my-fault while I was here - redid the imports on garden.graph. (Bring on `black`!)

Julian-O requested a review from misl6 December 7, 2023 12:37

misl6 approved these changes Dec 7, 2023

View reviewed changes

misl6 merged commit fee1bb2 into kivy:master Dec 7, 2023
4 of 5 checks passed

Julian-O deleted the hobgoblin branch December 8, 2023 04:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make doc structure consistent and up-to-date #786

Make doc structure consistent and up-to-date #786

Julian-O commented Nov 26, 2023

misl6 left a comment

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

Julian-O Dec 7, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 Dec 6, 2023

misl6 left a comment

		@@ -0,0 +1,8 @@
		# Contacting the Kivy Team

		Are you having trouble using the Kivy framework, or any of its related projects?

		Plyer is a platform-independent Python API for accessing features
		of various hardware platforms, especially Android and iOS devices.

	copyright = u'2013-2024, Kivy Team and other contributors'
	copyright = u'2013-2023, Kivy Team and other contributors'

	`latest contact details <https://github.com/kivy/kivy/blob/master/CONTACT.md>`_.
	`latest contact details <https://github.com/kivy/plyer/blob/master/CONTACT.md>`_.

	`latest license <https://github.com/kivy/kivy/blob/master/LICENSE>`_
	`latest license <https://github.com/kivy/plyer/blob/master/LICENSE>`_

Make doc structure consistent and up-to-date #786

Make doc structure consistent and up-to-date #786

Conversation

Julian-O commented Nov 26, 2023

misl6 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

misl6 left a comment

Choose a reason for hiding this comment