diff --git a/docs/rolereference.rst b/docs/rolereference.rst index d6e99de6cf3c25b15b0f8e2cea4aa6b0190b454c..3fe7ddcd9e804ff2b6b3fff372ad81a2fe9540fe 100644 --- a/docs/rolereference.rst +++ b/docs/rolereference.rst @@ -272,9 +272,9 @@ The role implements the following: upgrades on daily basis. Mails are delivered to local ``root`` account, and can be redirected elsewhere via aliases. If using ``mail_forwarder`` or ``mail_server`` roles on the same server, aliases can be set-up through them. -* Sets-up system for performing checks on pip requirements files. Only - Python 3 is supported. Roles that want their requirements files - checked should create a sub-directory inside of +* Sets-up system for performing checks on pip requirements + files. Roles that want their requirements files checked should + create a sub-directory inside of ``/etc/pip_check_requirements_upgrades``, and place ``.txt`` and ``.in`` files inside (with same base name). The ``.txt`` files should be standard requirements files with fixed versions (the ones @@ -417,11 +417,11 @@ Parameters **pip_check_requirements_in** (list, optional, ``[pip, pip-tools, setuptools, wheel]``) List of Python package requirements inputs to use for checking for - package upgrades for the Python 3 virtual environment used to run + package upgrades for the Python virtual environment used to run the check itself. **pip_check_requirements** (list, optional, ``see below``) - List of Python package requirements to install in Python 3 virtual + List of Python package requirements to install in Python virtual environment in order to be able to run the ``pip-tools`` applications as part of pip requirements upgrade checks. This list needs to be updated from time to time as the new releases of