From 1fe17f8c736fc2a254c2d38b0bf6734e7a9c9ec9 Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Thu, 2 Jul 2020 17:36:45 +0200 Subject: [PATCH] Adds croniter install note --- docs/install.rst | 3 +++ docs/schedules.rst | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/install.rst b/docs/install.rst index e3b1363..f794e57 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -88,6 +88,9 @@ Optional + +.. _croniter_package: + - `Croniter `__ is an optional package that is used to parse cron expressions for the scheduler:: $ pip install croniter diff --git a/docs/schedules.rst b/docs/schedules.rst index 5e2a080..9d4e5fe 100644 --- a/docs/schedules.rst +++ b/docs/schedules.rst @@ -95,6 +95,10 @@ Or you can make a wrapper function which you can then schedule in Django Q: Check out the :ref:`shell` examples if you want to schedule regular shell commands +.. note:: + + Schedules needs the optional :ref:`Croniter` package installed to parse cron expressions. + Reference --------- @@ -223,6 +227,6 @@ Reference .. py:attribute:: CRON - `'C'` uses the optional `croniter` package to determine a schedule based a cron expression. + `'C'` uses the optional `croniter` package to determine a schedule based on a cron expression.