diff --git a/changes/1786.doc.rst b/changes/1786.doc.rst new file mode 100644 index 000000000..dcb6efe9c --- /dev/null +++ b/changes/1786.doc.rst @@ -0,0 +1 @@ +Specific examples added for requires under configuration. diff --git a/docs/reference/configuration.rst b/docs/reference/configuration.rst index f038f2384..9cf896f4e 100644 --- a/docs/reference/configuration.rst +++ b/docs/reference/configuration.rst @@ -313,6 +313,9 @@ A hexadecimal RGB color value (e.g., ``#008577``) used alongside the primary color. This setting is only used if the platform allows color modification, otherwise it is ignored. + +.. _configuration-requires-key: + ``requires`` ~~~~~~~~~~~~ @@ -324,6 +327,35 @@ application level, *and* platform level, the final set of requirements will be the *concatenation* of requirements from all levels, starting from least to most specific. +Any PEP 508 version specifier is legal. For example: + +* Bare package name:: + + requires = ["pillow"] + +* Package name with version specifier:: + + requires = ["pillow==9.1.0"] + +* Install from source using the ``--no-binary`` entry:: + + requires = [ + "pillow==9.1.0", + "--no-binary", "pillow", + ] + +* Git repository:: + + requires=["git+https://github.com/beeware/briefcase.git"] + +* Local directory:: + + requires=["mysrc/myapp"] + +* Local wheel file:: + + requires=["fullpath/wheelfile.whl"] + ``revision`` ~~~~~~~~~~~~ @@ -402,6 +434,8 @@ level, application level, *and* platform level, the final set of requirements will be the *concatenation* of requirements from all levels, starting from least to most specific. +See :ref:`requires ` for examples. + ``test_sources`` ~~~~~~~~~~~~~~~~