fork/django-q2
1
0
Fork 0
mirror of https://github.com/django-q2/django-q2.git synced 2026-09-15 13:37:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adds croniter install note

Browse Source
This commit is contained in:
Ilan Steemers
2020-07-02 17:36:45 +02:00
parent f8479741bf
commit 1fe17f8c73
2 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/install.rst
View File

@@ -88,6 +88,9 @@ Optional
.. _croniter_package:
- `Croniter <https://github.com/kiorky/croniter>`__ is an optional package that is used to parse cron expressions for the scheduler::
$ pip install croniter

6
docs/schedules.rst
View File

@@ -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<croniter_package>` 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.