Make doc structure consistent and up-to-date (#8514)
* 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.
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.
[NA] 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.
[NA] Refers to kivy/kivy CODE_OF_CONDUCT.md
* CONTACT.md
[NA] 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.
[] 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.
[???] 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] NO_RESPONSE runs every day, and skips if forked.
[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 comment
2023-12-17 09:42:49 +00:00
|
|
|
MIT License
|
|
|
|
|
|
2024-01-01 11:02:34 +00:00
|
|
|
Copyright (c) 2010-2024 Kivy Team and other contributors
|
2013-08-01 14:29:23 +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.
|