From cddb9e4ab1c772d4898fc667463ada5a383292a2 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 30 Jan 2023 10:33:43 +0800 Subject: [PATCH] Add release notes for v0.3.0. --- README.rst | 6 +++--- changes/1439.bugfix.rst | 1 - changes/1633.misc.rst | 1 - changes/1638.misc.rst | 1 - changes/1641.feature.rst | 1 - changes/1643.misc.rst | 1 - changes/1647.misc.rst | 1 - changes/1648.misc.rst | 1 - changes/1649.misc.rst | 1 - changes/1653.misc.rst | 1 - changes/1659.bugfix.rst | 1 - changes/1660.bugfix.rst | 1 - changes/1662.misc.rst | 1 - changes/1663.misc.rst | 1 - changes/1666.misc.rst | 1 - changes/1669.misc.rst | 1 - changes/1673.misc.rst | 1 - changes/1675.misc.rst | 1 - changes/1677.feature.rst | 1 - changes/1681.misc.rst | 1 - changes/1686.feature.rst | 1 - changes/1687.misc.rst | 1 - changes/1699.bugfix.rst | 1 - changes/1700.misc.rst | 1 - changes/1705.bugfix.rst | 1 - changes/1707.misc.rst | 1 - changes/1709.misc.rst | 1 - changes/1710.feature.rst | 1 - changes/1711.misc.rst | 1 - changes/1712.misc.rst | 1 - changes/1717.misc.rst | 1 - changes/1720.misc.rst | 1 - changes/1724.doc.rst | 1 - changes/1725.bugfix.rst | 1 - changes/1726.doc.rst | 1 - changes/1728.feature.rst | 1 - changes/1729.doc.rst | 1 - changes/1730.misc.rst | 1 - changes/1731.bugfix.rst | 1 - changes/1733.misc.rst | 1 - changes/1734.misc.rst | 1 - changes/1735.misc.rst | 1 - changes/1736.misc.rst | 1 - changes/1737.misc.rst | 1 - changes/1738.misc.rst | 1 - changes/1739.misc.rst | 1 - changes/1740.misc.rst | 1 - changes/1741.misc.rst | 1 - changes/1742.misc.rst | 1 - changes/1743.misc.rst | 1 - changes/1747.misc.rst | 1 - changes/1748.misc.rst | 1 - changes/1749.misc.rst | 1 - changes/1751.misc.rst | 1 - changes/1755.misc.rst | 1 - changes/1756.bugfix.rst | 1 - changes/1757.bugfix.rst | 1 - core/setup.cfg | 6 ++++-- demo/setup.cfg | 2 +- docs/background/releases.rst | 19 ++++++++++++++----- docs/how-to/get-started.rst | 7 +------ docs/how-to/index.rst | 2 +- docs/how-to/internal/index.rst | 12 ++++++++++++ docs/how-to/{ => internal}/release.rst | 6 +++--- docs/tutorial/tutorial-0.rst | 10 +++++----- 65 files changed, 44 insertions(+), 82 deletions(-) delete mode 100644 changes/1439.bugfix.rst delete mode 100644 changes/1633.misc.rst delete mode 100644 changes/1638.misc.rst delete mode 100644 changes/1641.feature.rst delete mode 100644 changes/1643.misc.rst delete mode 100644 changes/1647.misc.rst delete mode 100644 changes/1648.misc.rst delete mode 100644 changes/1649.misc.rst delete mode 100644 changes/1653.misc.rst delete mode 100644 changes/1659.bugfix.rst delete mode 100644 changes/1660.bugfix.rst delete mode 100644 changes/1662.misc.rst delete mode 100644 changes/1663.misc.rst delete mode 100644 changes/1666.misc.rst delete mode 100644 changes/1669.misc.rst delete mode 100644 changes/1673.misc.rst delete mode 100644 changes/1675.misc.rst delete mode 100644 changes/1677.feature.rst delete mode 100644 changes/1681.misc.rst delete mode 100644 changes/1686.feature.rst delete mode 100644 changes/1687.misc.rst delete mode 100644 changes/1699.bugfix.rst delete mode 100644 changes/1700.misc.rst delete mode 100644 changes/1705.bugfix.rst delete mode 100644 changes/1707.misc.rst delete mode 100644 changes/1709.misc.rst delete mode 100644 changes/1710.feature.rst delete mode 100644 changes/1711.misc.rst delete mode 100644 changes/1712.misc.rst delete mode 100644 changes/1717.misc.rst delete mode 100644 changes/1720.misc.rst delete mode 100644 changes/1724.doc.rst delete mode 100644 changes/1725.bugfix.rst delete mode 100644 changes/1726.doc.rst delete mode 100644 changes/1728.feature.rst delete mode 100644 changes/1729.doc.rst delete mode 100644 changes/1730.misc.rst delete mode 100644 changes/1731.bugfix.rst delete mode 100644 changes/1733.misc.rst delete mode 100644 changes/1734.misc.rst delete mode 100644 changes/1735.misc.rst delete mode 100644 changes/1736.misc.rst delete mode 100644 changes/1737.misc.rst delete mode 100644 changes/1738.misc.rst delete mode 100644 changes/1739.misc.rst delete mode 100644 changes/1740.misc.rst delete mode 100644 changes/1741.misc.rst delete mode 100644 changes/1742.misc.rst delete mode 100644 changes/1743.misc.rst delete mode 100644 changes/1747.misc.rst delete mode 100644 changes/1748.misc.rst delete mode 100644 changes/1749.misc.rst delete mode 100644 changes/1751.misc.rst delete mode 100644 changes/1755.misc.rst delete mode 100644 changes/1756.bugfix.rst delete mode 100644 changes/1757.bugfix.rst create mode 100644 docs/how-to/internal/index.rst rename docs/how-to/{ => internal}/release.rst (97%) diff --git a/README.rst b/README.rst index 9367f91e9f..5e2b747129 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Toga ==== -.. image:: https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9%20|%203.10-blue.svg +.. image:: https://img.shields.io/pypi/pyversions/toga.svg :target: https://pypi.python.org/pypi/toga :alt: Python Versions @@ -19,7 +19,7 @@ Toga .. image:: https://img.shields.io/pypi/l/toga.svg :target: https://github.com/beeware/toga/blob/main/LICENSE - :alt: License + :alt: BSD License .. image:: https://github.com/beeware/toga/workflows/CI/badge.svg?branch=main :target: https://github.com/beeware/toga/actions @@ -64,7 +64,7 @@ Quickstart To get a demonstration of the capabilities of Toga, run the following:: - $ pip install --pre toga-demo + $ pip install toga-demo $ toga-demo This will pop up a GUI window with some sample widgets. diff --git a/changes/1439.bugfix.rst b/changes/1439.bugfix.rst deleted file mode 100644 index c46cefe082..0000000000 --- a/changes/1439.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Changes in the root content of a window are now correctly applied on GTK and iOS. diff --git a/changes/1633.misc.rst b/changes/1633.misc.rst deleted file mode 100644 index 5dfc13e046..0000000000 --- a/changes/1633.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed asyncio warning on iOS, and increased minimum Rubicon version so we can use ``run_forever_cooperatively``. diff --git a/changes/1638.misc.rst b/changes/1638.misc.rst deleted file mode 100644 index 96af939fd2..0000000000 --- a/changes/1638.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Towncrier was added to assist with the compilation of release notes. diff --git a/changes/1641.feature.rst b/changes/1641.feature.rst deleted file mode 100644 index a86c0d8428..0000000000 --- a/changes/1641.feature.rst +++ /dev/null @@ -1 +0,0 @@ -The contents of a Canvas can now be saved as an image, and images can be saved to disk. diff --git a/changes/1643.misc.rst b/changes/1643.misc.rst deleted file mode 100644 index e231c7e356..0000000000 --- a/changes/1643.misc.rst +++ /dev/null @@ -1 +0,0 @@ -CI was modified to use coverage directly, instead of reporting via CodeCov diff --git a/changes/1647.misc.rst b/changes/1647.misc.rst deleted file mode 100644 index bc4359a6a1..0000000000 --- a/changes/1647.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Bump codecov/codecov-action from 1 to 3. diff --git a/changes/1648.misc.rst b/changes/1648.misc.rst deleted file mode 100644 index ffdfaa6167..0000000000 --- a/changes/1648.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/setup-python from 3.1.2 to 4.3.0. diff --git a/changes/1649.misc.rst b/changes/1649.misc.rst deleted file mode 100644 index 2d0e87fa42..0000000000 --- a/changes/1649.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated dsaltares/fetch-gh-release-asset from 1.0.0 to 1.1.0. diff --git a/changes/1653.misc.rst b/changes/1653.misc.rst deleted file mode 100644 index f42e75f83f..0000000000 --- a/changes/1653.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Added a missing quote mark to box.rst. diff --git a/changes/1659.bugfix.rst b/changes/1659.bugfix.rst deleted file mode 100644 index 56ab0c4873..0000000000 --- a/changes/1659.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -An error caused by retrieving `app.current_window` on macOS has been resolved. diff --git a/changes/1660.bugfix.rst b/changes/1660.bugfix.rst deleted file mode 100644 index ec524a5b96..0000000000 --- a/changes/1660.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -If a window has existing content when it is added to an app, the widget registry no longer raises an error. diff --git a/changes/1662.misc.rst b/changes/1662.misc.rst deleted file mode 100644 index 3fba858037..0000000000 --- a/changes/1662.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/checkout from 1 to 3. diff --git a/changes/1663.misc.rst b/changes/1663.misc.rst deleted file mode 100644 index a264637bb4..0000000000 --- a/changes/1663.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pyupgrade from 2.38.2 to 3.2.0 and black from 22.8.0 to 22.10.0. diff --git a/changes/1666.misc.rst b/changes/1666.misc.rst deleted file mode 100644 index 05bdc54107..0000000000 --- a/changes/1666.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The docstring for the ``hide`` method was corrected. diff --git a/changes/1669.misc.rst b/changes/1669.misc.rst deleted file mode 100644 index 280edc1515..0000000000 --- a/changes/1669.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Moved all packages to be top-level directories in the repository. diff --git a/changes/1673.misc.rst b/changes/1673.misc.rst deleted file mode 100644 index 64ea19c26a..0000000000 --- a/changes/1673.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Corrected coverage path mapping. diff --git a/changes/1675.misc.rst b/changes/1675.misc.rst deleted file mode 100644 index cfe3da8b4a..0000000000 --- a/changes/1675.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Moved to setuptools-scm. diff --git a/changes/1677.feature.rst b/changes/1677.feature.rst deleted file mode 100644 index 89008bc3d6..0000000000 --- a/changes/1677.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Support for Python 3.12 was added. diff --git a/changes/1681.misc.rst b/changes/1681.misc.rst deleted file mode 100644 index bbfe6efbf6..0000000000 --- a/changes/1681.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated ncipollo/release-action from 1.11.1 to 1.11.2. diff --git a/changes/1686.feature.rst b/changes/1686.feature.rst deleted file mode 100644 index 477a211219..0000000000 --- a/changes/1686.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Apps can now specify the order in which widgets receive focus. diff --git a/changes/1687.misc.rst b/changes/1687.misc.rst deleted file mode 100644 index 66c7d93862..0000000000 --- a/changes/1687.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Added a backend test app. diff --git a/changes/1699.bugfix.rst b/changes/1699.bugfix.rst deleted file mode 100644 index 40eb4826fe..0000000000 --- a/changes/1699.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -DateTime widgets on Windows are able to generate dates that are independent of the system locale. diff --git a/changes/1700.misc.rst b/changes/1700.misc.rst deleted file mode 100644 index db05ca8b1a..0000000000 --- a/changes/1700.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Stale references to OS X and the Django backend were updated. diff --git a/changes/1705.bugfix.rst b/changes/1705.bugfix.rst deleted file mode 100644 index 9a5754482f..0000000000 --- a/changes/1705.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Background tasks are now added in threadsafe mode. diff --git a/changes/1707.misc.rst b/changes/1707.misc.rst deleted file mode 100644 index a7ed1016a0..0000000000 --- a/changes/1707.misc.rst +++ /dev/null @@ -1 +0,0 @@ -An initial macOS probe implementation was added. diff --git a/changes/1709.misc.rst b/changes/1709.misc.rst deleted file mode 100644 index 02b5236759..0000000000 --- a/changes/1709.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated CI to use the centralized Dependabot changenote workflow in the ``beeware/.github`` repo. diff --git a/changes/1710.feature.rst b/changes/1710.feature.rst deleted file mode 100644 index 797609bff5..0000000000 --- a/changes/1710.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Canvas events are now supported in GTK. diff --git a/changes/1711.misc.rst b/changes/1711.misc.rst deleted file mode 100644 index e8b75ba334..0000000000 --- a/changes/1711.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/setup-python from 4.3.0 to 4.3.1. diff --git a/changes/1712.misc.rst b/changes/1712.misc.rst deleted file mode 100644 index 764c5ea7d1..0000000000 --- a/changes/1712.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Some small changes were made to support recent changes in CI environments. diff --git a/changes/1717.misc.rst b/changes/1717.misc.rst deleted file mode 100644 index f3996d729e..0000000000 --- a/changes/1717.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated ncipollo/release-action from 1.11.2 to 1.12.0. diff --git a/changes/1720.misc.rst b/changes/1720.misc.rst deleted file mode 100644 index f0ee451ef7..0000000000 --- a/changes/1720.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/setup-python from 4.3.1 to 4.4.0. diff --git a/changes/1724.doc.rst b/changes/1724.doc.rst deleted file mode 100644 index e758ccc26a..0000000000 --- a/changes/1724.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Release history now contains links to GitHub issues. diff --git a/changes/1725.bugfix.rst b/changes/1725.bugfix.rst deleted file mode 100644 index a36d100309..0000000000 --- a/changes/1725.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Usage of asyncio in GTK has been updated to match Python 3.11 APIs. diff --git a/changes/1726.doc.rst b/changes/1726.doc.rst deleted file mode 100644 index 098aa1a7f8..0000000000 --- a/changes/1726.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Corrected link to toga docs for first time contributors. diff --git a/changes/1728.feature.rst b/changes/1728.feature.rst deleted file mode 100644 index 3322b87a09..0000000000 --- a/changes/1728.feature.rst +++ /dev/null @@ -1 +0,0 @@ -MultilineTextView can now be programmatically scrolled to the top or bottom of the text field. diff --git a/changes/1729.doc.rst b/changes/1729.doc.rst deleted file mode 100644 index 46dd2e3d20..0000000000 --- a/changes/1729.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated documentation for code contributors with installation of tox and information about naming change files. diff --git a/changes/1730.misc.rst b/changes/1730.misc.rst deleted file mode 100644 index cef8bf1b81..0000000000 --- a/changes/1730.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Docstrings for WebView have been corrected. diff --git a/changes/1731.bugfix.rst b/changes/1731.bugfix.rst deleted file mode 100644 index 833a4a2c5e..0000000000 --- a/changes/1731.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -The way dependency versions are specified has been modified to make Toga as accomodating as possible with end-user environments, but as stable as possible for development environments. diff --git a/changes/1733.misc.rst b/changes/1733.misc.rst deleted file mode 100644 index 03eca50083..0000000000 --- a/changes/1733.misc.rst +++ /dev/null @@ -1 +0,0 @@ -An error in a documentation error for commands was corrected. diff --git a/changes/1734.misc.rst b/changes/1734.misc.rst deleted file mode 100644 index f44c437514..0000000000 --- a/changes/1734.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated coverage[toml] from 7.0.4 to 7.0.5 in /core. diff --git a/changes/1735.misc.rst b/changes/1735.misc.rst deleted file mode 100644 index b86ae76acd..0000000000 --- a/changes/1735.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated tox from 4.0.1 to 4.2.7 in /core. diff --git a/changes/1736.misc.rst b/changes/1736.misc.rst deleted file mode 100644 index 6d3dede6bc..0000000000 --- a/changes/1736.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated sphinx from 6.1.2 to 6.1.3 in /core. diff --git a/changes/1737.misc.rst b/changes/1737.misc.rst deleted file mode 100644 index 4a495ba1bf..0000000000 --- a/changes/1737.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated actions/setup-python from 4.4.0 to 4.5.0. diff --git a/changes/1738.misc.rst b/changes/1738.misc.rst deleted file mode 100644 index f94ffb8479..0000000000 --- a/changes/1738.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated pytest from 7.2.0 to 7.2.1 in /core. diff --git a/changes/1739.misc.rst b/changes/1739.misc.rst deleted file mode 100644 index 9cbdd887d9..0000000000 --- a/changes/1739.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated tox from 4.2.7 to 4.2.8 in /core. diff --git a/changes/1740.misc.rst b/changes/1740.misc.rst deleted file mode 100644 index 179280b23e..0000000000 --- a/changes/1740.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Stale references to the master branch in README badges was corrected. diff --git a/changes/1741.misc.rst b/changes/1741.misc.rst deleted file mode 100644 index 80d2f18238..0000000000 --- a/changes/1741.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Some apps have been added to the success stories diff --git a/changes/1742.misc.rst b/changes/1742.misc.rst deleted file mode 100644 index 45eecb620e..0000000000 --- a/changes/1742.misc.rst +++ /dev/null @@ -1 +0,0 @@ -A little code cleaning for isort to recognize testbed module. diff --git a/changes/1743.misc.rst b/changes/1743.misc.rst deleted file mode 100644 index c019495609..0000000000 --- a/changes/1743.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Stale references to the master branch was corrected to the main branch in the whole project. diff --git a/changes/1747.misc.rst b/changes/1747.misc.rst deleted file mode 100644 index 9addff6a7f..0000000000 --- a/changes/1747.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Remove Android test discovery workarounds diff --git a/changes/1748.misc.rst b/changes/1748.misc.rst deleted file mode 100644 index 2e114ca1c5..0000000000 --- a/changes/1748.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated tox from 4.2.8 to 4.3.5 in /core. diff --git a/changes/1749.misc.rst b/changes/1749.misc.rst deleted file mode 100644 index 9e37472591..0000000000 --- a/changes/1749.misc.rst +++ /dev/null @@ -1 +0,0 @@ -An initial iOS probe implementation was added. diff --git a/changes/1751.misc.rst b/changes/1751.misc.rst deleted file mode 100644 index 4f9fa86be5..0000000000 --- a/changes/1751.misc.rst +++ /dev/null @@ -1 +0,0 @@ -The Rubicon-ObjC version specifier was updated to an RC version because 0.4.4 was yanked, but we need the new features in the main branch. diff --git a/changes/1755.misc.rst b/changes/1755.misc.rst deleted file mode 100644 index 4be0a85b1e..0000000000 --- a/changes/1755.misc.rst +++ /dev/null @@ -1 +0,0 @@ -A GTK GUI test probe was added. diff --git a/changes/1756.bugfix.rst b/changes/1756.bugfix.rst deleted file mode 100644 index 9ef2da3146..0000000000 --- a/changes/1756.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix setting enabled state on NumberInput widget in Cocoa backend. diff --git a/changes/1757.bugfix.rst b/changes/1757.bugfix.rst deleted file mode 100644 index bd0196e2d0..0000000000 --- a/changes/1757.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix updating the value and calling on_change for NumberInput widgets in Cococa. diff --git a/core/setup.cfg b/core/setup.cfg index f4ae687d98..0dac751c71 100644 --- a/core/setup.cfg +++ b/core/setup.cfg @@ -56,7 +56,7 @@ install_requires = packages = find: package_dir = = src -python_requires = >= 3.6 +python_requires = >= 3.7 zip_safe = False [options.extras_require] @@ -64,7 +64,9 @@ zip_safe = False # ensure environment consistency. dev = coverage[toml] == 7.0.5 - pre-commit == 2.21.0 + # Pre-commit 3.0 dropped support for Python 3.7 + pre-commit == 2.21.0; python_version < "3.8" + pre-commit == 3.0.2; python_version >= "3.8" pytest == 7.2.1 pytest-tldr == 0.2.5 setuptools-scm[toml] == 7.0.5 diff --git a/demo/setup.cfg b/demo/setup.cfg index 2e3488e34c..2831b799f6 100644 --- a/demo/setup.cfg +++ b/demo/setup.cfg @@ -49,7 +49,7 @@ keywords = [options] packages = find: -python_requires = >= 3.5 +python_requires = >= 3.7 zip_safe = False [options.entry_points] diff --git a/docs/background/releases.rst b/docs/background/releases.rst index a6c336e689..a4ef832671 100644 --- a/docs/background/releases.rst +++ b/docs/background/releases.rst @@ -3,12 +3,21 @@ Release History .. towncrier release notes start -0.3.0 ------ +0.3.0 (2023-01-30) +================== + +Features +-------- + +* Widgets now use a three-layered (Interface/Implementation/Native) structure. +* A GUI testing framework was added. +* A simplified "Pack" layout algorithm was added. +* Added a web backend. + +Bugfixes +-------- -* Move to a three-layered Interface/Implementation/Native code structure -* Added a test framework -* Added a simplified "Pack" layout +* Too many to count! 0.2.15 ------ diff --git a/docs/how-to/get-started.rst b/docs/how-to/get-started.rst index bd14d847fe..29c5d22d0d 100644 --- a/docs/how-to/get-started.rst +++ b/docs/how-to/get-started.rst @@ -15,15 +15,10 @@ Quickstart Create a new virtualenv. In your virtualenv, install Toga, and then run it:: - $ pip install toga-demo + $ python -m pip install toga-demo $ toga-demo This will pop up a GUI window showing the full range of widgets available to an application using Toga. -There is a known issue with the current build on some Mac OS distributions. If you are -running Mac OS Sierra or higher, use the following installation command instead:: - - $ pip install toga-demo --pre - Have fun, and see the :ref:`reference` to learn more about what's going on. diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 7bacdc2017..93fba538e3 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -16,4 +16,4 @@ stand alone. Get started Contribute code to Toga Contribute documentation to Toga - Cut a Toga release + internal/index diff --git a/docs/how-to/internal/index.rst b/docs/how-to/internal/index.rst new file mode 100644 index 0000000000..a2d71ea1f8 --- /dev/null +++ b/docs/how-to/internal/index.rst @@ -0,0 +1,12 @@ +====================== +Internal How-to guides +====================== + +These guides are for the maintainers of the Toga project, documenting +internal project procedures. + +.. toctree:: + :maxdepth: 2 + :glob: + + release diff --git a/docs/how-to/release.rst b/docs/how-to/internal/release.rst similarity index 97% rename from docs/how-to/release.rst rename to docs/how-to/internal/release.rst index 452abdb8cd..f18e050ae2 100644 --- a/docs/how-to/release.rst +++ b/docs/how-to/internal/release.rst @@ -1,6 +1,6 @@ -============================== +========================= How to cut a Toga release -============================== +========================= The release infrastructure for Toga is semi-automated, using GitHub Actions to formally publish releases. @@ -34,7 +34,7 @@ The procedure for cutting a new release is as follows: #. Tag the release, and push the branch and tag upstream:: $ git tag v1.2.3 - $ git push upstream main + $ git push upstream HEAD:main $ git push upstream v1.2.3 #. Pushing the tag will start a workflow to create a draft release on GitHub. diff --git a/docs/tutorial/tutorial-0.rst b/docs/tutorial/tutorial-0.rst index 97ad9d3045..612a4d8e8f 100644 --- a/docs/tutorial/tutorial-0.rst +++ b/docs/tutorial/tutorial-0.rst @@ -58,7 +58,7 @@ Next, install Toga into your virtual environment: .. code-block:: bash - (venv) $ python -m pip install --pre toga + (venv) $ python -m pip install toga .. group-tab:: Linux @@ -72,7 +72,7 @@ Next, install Toga into your virtual environment: (venv) $ sudo apt-get update (venv) $ sudo apt-get install python3-dev python3-gi python3-gi-cairo libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit2-3.0 - # Ubuntu 18.04 / Ubuntu 20.04 / Debian 10 / Debian 11 + # Ubuntu 18.04+ / Debian 10+ (venv) $ sudo apt-get update (venv) $ sudo apt-get install python3-dev python3-gi python3-gi-cairo libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkit2gtk-4.0-37 gir1.2-webkit2-4.0 @@ -91,13 +91,13 @@ Next, install Toga into your virtual environment: .. code-block:: bash - (venv) $ python -m pip install --pre toga + (venv) $ python -m pip install toga .. group-tab:: Windows .. code-block:: doscon - (venv) C:\...>python -m pip install --pre toga + (venv) C:\...>python -m pip install toga If you get other errors, please check that you followed `the prerequisite `_ instructions. @@ -253,7 +253,7 @@ Occasionally you might run into issues running Toga on your computer. Before you run the app, you'll need to install toga. Although you *can* install toga by just running:: - $ python -m pip install --pre toga + $ python -m pip install toga We strongly suggest that you **don't** do this. We'd suggest creating a `virtual environment`_ first, and installing toga in that virtual environment as directed