diff options
author | agronholm <devnull@localhost> | 2011-04-11 02:20:52 +0300 |
---|---|---|
committer | agronholm <devnull@localhost> | 2011-04-11 02:20:52 +0300 |
commit | de7f3ac95101159dfb3884f09b62b7cf58399c5e (patch) | |
tree | e45a3c32f9ddea5face690e31bc8e5c07091b77b | |
parent | 0915f85b7a2047c2469adc69ddcba2b14b104be8 (diff) | |
download | apscheduler-de7f3ac95101159dfb3884f09b62b7cf58399c5e.tar.gz |
Documentation improvements
-rw-r--r-- | docs/extending.rst | 14 | ||||
-rw-r--r-- | docs/modules/jobstores/mongodb.rst | 10 | ||||
-rw-r--r-- | docs/modules/jobstores/ram.rst | 10 | ||||
-rw-r--r-- | docs/modules/jobstores/shelve.rst | 10 | ||||
-rw-r--r-- | docs/modules/jobstores/sqlalchemy.rst | 10 |
5 files changed, 44 insertions, 10 deletions
diff --git a/docs/extending.rst b/docs/extending.rst index 4228146..1030dae 100644 --- a/docs/extending.rst +++ b/docs/extending.rst @@ -11,10 +11,10 @@ Writing and using custom triggers If you need to use some specialized scheduling algorithm, you can implement that as a custom trigger class. The only method a trigger class has to implement is ``get_next_fire_time``. This method receives a starting date -(a :class:``~datetime.datetime`` object) as its sole argument, and the method -should return the next time the trigger will fire, according to whatever -scheduling logic you wish to implement. If no such date/time can be computed, -it should return ``None``. +(a :class:`~datetime.datetime` object) as its sole argument. It should return +the next time the trigger will fire (starting from and including the given time), +according to whatever scheduling logic you wish to implement. If no such +datetime can be computed, it should return ``None``. To schedule a job using your custom trigger, you can either extends the :class:`~apscheduler.scheduler.Scheduler` class to include your own shortcuts, @@ -36,9 +36,3 @@ To use your job store, you must add it to the scheduler as normal:: jobstore = MyJobStore() scheduler.add_jobstore(jobstore) - -If you do not specify an explicit alias when adding the job store, it will be -automatically determined from the class name. The class name is converted to -lower case and the "jobstore" suffix is removed. Thus, for "MyJobStore", the -alias would be "my". You can override the default behavior by setting the -``default_alias`` variable in your job store. diff --git a/docs/modules/jobstores/mongodb.rst b/docs/modules/jobstores/mongodb.rst new file mode 100644 index 0000000..c37a98b --- /dev/null +++ b/docs/modules/jobstores/mongodb.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.mongodb_store` +============================================= + +.. automodule:: apscheduler.jobstores.mongodb_store + +Module Contents +--------------- + +.. autoclass:: MongoDBJobStore + :members: diff --git a/docs/modules/jobstores/ram.rst b/docs/modules/jobstores/ram.rst new file mode 100644 index 0000000..4f56a1d --- /dev/null +++ b/docs/modules/jobstores/ram.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.ram_store` +============================================= + +.. automodule:: apscheduler.jobstores.ram_store + +Module Contents +--------------- + +.. autoclass:: RAMJobStore + :members: diff --git a/docs/modules/jobstores/shelve.rst b/docs/modules/jobstores/shelve.rst new file mode 100644 index 0000000..e28f58d --- /dev/null +++ b/docs/modules/jobstores/shelve.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.shelve_store` +========================================= + +.. automodule:: apscheduler.jobstores.shelve_store + +Module Contents +--------------- + +.. autoclass:: ShelveJobStore + :members: diff --git a/docs/modules/jobstores/sqlalchemy.rst b/docs/modules/jobstores/sqlalchemy.rst new file mode 100644 index 0000000..c78054c --- /dev/null +++ b/docs/modules/jobstores/sqlalchemy.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.sqlalchemy_store` +============================================= + +.. automodule:: apscheduler.jobstores.sqlalchemy_store + +Module Contents +--------------- + +.. autoclass:: SQLAlchemyJobStore + :members: |