* 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
* Add FAQ as separate document. Removed from RST docs.
Future work:
* Add references to contact us.
* Substantial Rewrite of Contributing Guidelines
* Updated with review comments.
* Avoid duplicating contribution instructions
Reference the contribution guidelines online rather than repeating them.
Make language more consistent with other sources.
* Reshuffle contents based on review comments.
* Move contributing to root dir, populate it with contents of contribute.rst and contribute-unittest.rst
* Delete contribute.rst and contribute-unittest.rst
* Delete the defunct Google Summers of Code
*Add CONTACT.md, populating it from CONTACT.rst.
* Reference new CONTACT.md from Index.
* Fix broken links, ToC.
* Fix another link.
* Bring in changes to README and setup.py from #8450.
* Include OpenGL reference
* Mention all the sponsors.
* Wrong README file was modified - try again
* Updated a bunch of http -> https
Not every single instance, but made a major dent.
Only instances where https worked (inclem.net, I am looking at you.)
* Update CODE_OF_CONDUCT.md to be the most modern version
* Update with review comments
* Correct link
* Add stubs for GitHub-hosted pages
* Fix links
RST broken by line feed.
Inline link.
Fourteen days isn't very long to respond to a request for more information, especially given it may come in weeks, months or years after the original request.
Vacations last longer than time. Development crunches last longer than that.
Let's give them 6 weeks before the bot gets upset.
[I am preparing to share this script across Kivy projects.]
* Add python:3.11-bookworm to rpi builds
* Update patchelf to 0.18.0
* Do not unpack directly to /
* Use the proper manylinux target platform for bookworm
* Test back 0.17.2
* Updated docs to reflect bookworm support addition
* Test on Python 3.11 (except Apple Silicon)
* Add comment about gstreamer 0.4.0
* Bump cython to 0.29.32 for 3.11 support.
* Bump cibuildwheel to 2.11.2 and add config for 3.11
Co-authored-by: Matt Einhorn <matt@einhorn.dev>
Found via `codespell -q 3 -S ./doc/sources/changelog.rst -L als,ba,childrens,childs,co-ordinate,co-ordinates,datas,enew,everytime,inout,iself,quitted,tesselate,tesselated,tesselator,ths`
* Add python3.10 in the ci configuration
* Update setup.cfg and setup.py for python3.10
* also update pyproject.toml to allow using latest cython
* update kivy-deps.sdl2 required version in setup.cfg
* bump kivy-deps.sdl2 version
* use develop version of pyinstaller for python3.10 support
* osx try simplified build
* force usage of next funcparserlib release that doesnt use 2to3 in setup.py
* 3.6 reached EOL on 2021-12-23
* macOS: add cp310-macosx_universal2
* We don't install anymore the full version. So ffmpeg dependency is not needed anymore. I expect to have a universal2 whl for ffpyplayer when we will switch back to full,dev
* manylinux2010 --> manylinux2014 (via cibuildwheel)
* Remove dependencies, so we can check delocating. Installs dev version cause support for 3.10 in ffpyplayer is missing
* Update manylinux sdl2 version and max cython version.
* Bump win deps.
Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com>
Co-authored-by: Matt Einhorn <moiein2000@gmail.com>
Co-authored-by: Matthew Einhorn <matt@einhorn.dev>
Mirko Galimberti