Make doc structure consistent and up-to-date #77
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
[NA] 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.
[NA] 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
[x] 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
[NA] Describes the project.
[NA] Describes its place in the Kivy sibling projects.
[NA] Mentions (Kivy/Kivy) Contact Us link.
[NA] Mentions LICENSE.
[NA] Mentions CONTRIBUTING
[NA] Mentions FAQ
[NA] conf.py mentioned Kivy Team and other contributors
- copyright, latex_documents, man_pages, texinfo documents
WORKFLOWS
[NA] NO_RESPONSE.yml is present if the repo has awaiting_reply tag.
[NA] NO_RESPONSE uses latest script versions.
[NA] NO_RESPONSE runs every day, and skips if forked.
[NA] SUPPORT.yml is present if the repo has a
support
tag.[NA] 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
[NA] Supplies Documentation, if any, to PyPI