Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Buildozer docs report wrong version #1738

Open
Julian-O opened this issue Nov 13, 2023 · 1 comment
Open

Buildozer docs report wrong version #1738

Julian-O opened this issue Nov 13, 2023 · 1 comment
Assignees

Comments

@Julian-O
Copy link
Contributor

According to top corner of Read The Docs (latest) we are up to Buildozer 0.11.
According to PyPi we are up to Buildozer 1.5.0.

Correct the documents (ideally in a way that automatically updates with the setup config).

@Julian-O
Copy link
Contributor Author

Hmmm... There is also a correctly numbered 1.5.0 version and an unnumbered stable. It is just "latest" that doesn't show the latest.

At the same time conf.py currently contains 0.11 in a couple of places, which I assumed was the source.

@Julian-O Julian-O removed the easy label Nov 13, 2023
@Julian-O Julian-O self-assigned this Dec 4, 2023
Julian-O added a commit to Julian-O/buildozer that referenced this issue Dec 4, 2023
This is part of an effort to make the Kivy sibling projects' documentation
structure consistent and up-to-date.

Unrelated fixes:
* Documentation version number now fetched from `buildozer/__init__.py`. Addresses kivy#1738
* Implemented many/all of the formatting changes from kivy#1708.
* Copy-edit of documents.
   * Contents of Contributing.rst moved to CONTRIBUTING.md
   * Removed installation intructions from README.md, so there is only one
     version.
   * Added Recipes description to RST documentation
   * Removed broken index page

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 added a commit that referenced this issue Dec 4, 2023
* 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 fixes:
* Documentation version number now fetched from `buildozer/__init__.py`. Addresses #1738
* Implemented many/all of the formatting changes from #1708.
* Copy-edit of documents.
   * Contents of Contributing.rst moved to CONTRIBUTING.md
   * Removed installation intructions from README.md, so there is only one
     version.
   * Added Recipes description to RST documentation
   * Removed broken index page

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

* Buildozer.io is a broken link

* Update docs/source/installation.rst

Co-authored-by: Mirko Galimberti <[email protected]>

---------

Co-authored-by: Mirko Galimberti <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant