Make doc structure consistent and up-to-date (#703)
* 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.
Extra items:
* Fix capitalisation of PyJNIus throughout.
* Standardize on tag line.
* Remove "shell" from "shell environment variables"
* Remove some Python 2-only code.
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
[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 CONTRIBUTING exists, mentions it.
[x] If LICENSE exists, mentions it.
[x] If CODE_OF_CONDUCT exists, mentions it.
[x] Mentions kivy/kivy CONTACT.md
[x] 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
[x] Mentions CODE_OF_CONDUCT
[x] Mentions FAQ
* 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
[x] SYPPORT.yml uses dessant/support-requests@v4
* 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
* Update with review comments
Tweaked SVG sizes.
Made warning use Markdown syntax for warnings.
Remove links overriding SVG for backers.
Remove kivy/kivy contributors, and link to pyJNIus ones.
Include the horrid links to sponsors, and link to why.
Added badge for GitHub contributors to this project (in contrast to OpenCollective contributors to Kivy)
Updated checklist
* CONTRIBUTING.md
[] If repo takes user contributions, is present
[] In root dir (not .github dir)
[] Explains relationship to Kivy, if unclear.
[] Refers to kivy/kivy Contribution Guidelines.
* LICENSE
[] If repo takes user contributions, is present.
[] Acknowledges the range of years to 2023.
[] Acknowledges Kivy Team and other contributors
[] Mentions it is an MIT License.
* CODE_OF_CONDUCT.md
[] If repo takes user contributions or hosts discussions, is present.
[] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[] Refers to kivy/kivy CONTACT.md
* FAQ.md
[] If repo is big enough for RST documentation, is present.
* README:
[] Is a Markdown file.
[] Describes the project.
[] Describes its place in the Kivy sibling projects.
[] If Documentation exists, mention it.
[] If CONTRIBUTING exists, mentions it.
[] If LICENSE exists, mentions it.
[] If CODE_OF_CONDUCT exists, mentions it.
[] Mentions kivy/kivy CONTACT.md
[] Uses Python syntax colouring for embedded Python code.
[] Uses badges to display current status, including:
[] Backers
[] Sponsors
[] GitHub contributors
[] Contributor Covenant
[] PyPI Version
[] PyPI Python Version
[] Build/Test status
[] Links to GitHub contributors
[] Displays backers in suitable icon size, without buttons.
[] Displays first 40 sponsors icons and links
* RST documentation, if present
[] Describes the project.
[] Describes its place in the Kivy sibling projects.
[] Mentions (Kivy/Kivy) Contact Us link.
[] Mentions LICENSE.
[] Mentions CONTRIBUTING
[] Mentions FAQ
[] conf.py mentioned Kivy Team and other contributors
- copyright, latex_documents, man_pages, texinfo documents
* WORKFLOWS
[] NO_RESPONSE.yml is present if the repo has awaiting_reply tag.
[] NO_RESPONSE uses latest script versions.
[] SUPPORT.yml is present if the repo has a `support` tag.
[] SUPPORT.yml refers to repo's CONTACT.md
* setup.py/cfg, if present and on PyPI
[] Supplies description to PyPI
[] Supplies Python versions to PyPI
[] Supplies Documentation, if any, to PyPI
* Improve links to sponsors, backers and contributors
See https://github.com/orgs/kivy/discussions/15 for context.
* Correct contributor URL
Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com>
---------
Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com>
2023-12-03 15:41:40 +00:00
|
|
|
MIT License
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2010-2023 Kivy Team and other contributors
|
2013-08-01 14:36:25 +00:00
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
|
THE SOFTWARE.
|