diff options
author | Alex Grönholm <alex.gronholm@nextday.fi> | 2014-05-28 02:03:35 +0300 |
---|---|---|
committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2014-05-28 02:29:20 +0300 |
commit | 5680a3a67915a0080dc1bcf569abf10a298ea889 (patch) | |
tree | f3d879f84bad3b650df70eeb4369be897531e5f0 /docs | |
parent | aeae7f98af054015885154fe41718786af8a09e9 (diff) | |
download | apscheduler-5680a3a67915a0080dc1bcf569abf10a298ea889.tar.gz |
Updated API documentation
Diffstat (limited to 'docs')
25 files changed, 193 insertions, 40 deletions
diff --git a/docs/modules/executors/asyncio.rst b/docs/modules/executors/asyncio.rst new file mode 100644 index 0000000..9ad09c4 --- /dev/null +++ b/docs/modules/executors/asyncio.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.executors.asyncio` +==================================== + +.. automodule:: apscheduler.executors.asyncio + +Module Contents +--------------- + +.. autoclass:: AsyncIOExecutor + :members: diff --git a/docs/modules/executors/base.rst b/docs/modules/executors/base.rst new file mode 100644 index 0000000..5c4bfe7 --- /dev/null +++ b/docs/modules/executors/base.rst @@ -0,0 +1,11 @@ +:mod:`apscheduler.executors.base` +================================= + +.. automodule:: apscheduler.executors.base + +Module Contents +--------------- + +.. autoclass:: BaseExecutor + :members: + diff --git a/docs/modules/executors/gevent.rst b/docs/modules/executors/gevent.rst new file mode 100644 index 0000000..8546361 --- /dev/null +++ b/docs/modules/executors/gevent.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.executors.gevent` +=================================== + +.. automodule:: apscheduler.executors.gevent + +Module Contents +--------------- + +.. autoclass:: GeventExecutor + :members: diff --git a/docs/modules/executors/pool.rst b/docs/modules/executors/pool.rst new file mode 100644 index 0000000..39bce1b --- /dev/null +++ b/docs/modules/executors/pool.rst @@ -0,0 +1,11 @@ +:mod:`apscheduler.executors.pool` +================================= + +.. automodule:: apscheduler.executors.pool + +Module Contents +--------------- + +.. autoclass:: PoolExecutor + :members: + diff --git a/docs/modules/executors/twisted.rst b/docs/modules/executors/twisted.rst new file mode 100644 index 0000000..60664ee --- /dev/null +++ b/docs/modules/executors/twisted.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.executors.twisted` +==================================== + +.. automodule:: apscheduler.executors.twisted + +Module Contents +--------------- + +.. autoclass:: TwistedExecutor + :members: diff --git a/docs/modules/job.rst b/docs/modules/job.rst index d9948eb..b140f02 100644 --- a/docs/modules/job.rst +++ b/docs/modules/job.rst @@ -7,3 +7,4 @@ Module Contents --------------- .. autoclass:: Job + :members: diff --git a/docs/modules/jobstores/base.rst b/docs/modules/jobstores/base.rst new file mode 100644 index 0000000..977bad5 --- /dev/null +++ b/docs/modules/jobstores/base.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.base` +================================= + +.. automodule:: apscheduler.jobstores.base + +Module Contents +--------------- + +.. autoclass:: BaseJobStore + :members: diff --git a/docs/modules/jobstores/memory.rst b/docs/modules/jobstores/memory.rst new file mode 100644 index 0000000..5bf2356 --- /dev/null +++ b/docs/modules/jobstores/memory.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.jobstores.memory` +=================================== + +.. automodule:: apscheduler.jobstores.memory + +Module Contents +--------------- + +.. autoclass:: MemoryJobStore + :members: diff --git a/docs/modules/jobstores/mongodb.rst b/docs/modules/jobstores/mongodb.rst index c37a98b..5707122 100644 --- a/docs/modules/jobstores/mongodb.rst +++ b/docs/modules/jobstores/mongodb.rst @@ -1,7 +1,7 @@ -:mod:`apscheduler.jobstores.mongodb_store` -============================================= +:mod:`apscheduler.jobstores.mongodb` +==================================== -.. automodule:: apscheduler.jobstores.mongodb_store +.. automodule:: apscheduler.jobstores.mongodb Module Contents --------------- diff --git a/docs/modules/jobstores/ram.rst b/docs/modules/jobstores/ram.rst deleted file mode 100644 index 4f56a1d..0000000 --- a/docs/modules/jobstores/ram.rst +++ /dev/null @@ -1,10 +0,0 @@ -:mod:`apscheduler.jobstores.ram_store` -============================================= - -.. automodule:: apscheduler.jobstores.ram_store - -Module Contents ---------------- - -.. autoclass:: RAMJobStore - :members: diff --git a/docs/modules/jobstores/redis.rst b/docs/modules/jobstores/redis.rst index be63fed..3747a68 100644 --- a/docs/modules/jobstores/redis.rst +++ b/docs/modules/jobstores/redis.rst @@ -1,7 +1,7 @@ -:mod:`apscheduler.jobstores.redis_store` -============================================= +:mod:`apscheduler.jobstores.redis` +======================================== -.. automodule:: apscheduler.jobstores.redis_store +.. automodule:: apscheduler.jobstores.redis Module Contents --------------- diff --git a/docs/modules/jobstores/shelve.rst b/docs/modules/jobstores/shelve.rst deleted file mode 100644 index e28f58d..0000000 --- a/docs/modules/jobstores/shelve.rst +++ /dev/null @@ -1,10 +0,0 @@ -: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 index c78054c..a6124d9 100644 --- a/docs/modules/jobstores/sqlalchemy.rst +++ b/docs/modules/jobstores/sqlalchemy.rst @@ -1,7 +1,7 @@ -:mod:`apscheduler.jobstores.sqlalchemy_store` -============================================= +:mod:`apscheduler.jobstores.sqlalchemy` +======================================= -.. automodule:: apscheduler.jobstores.sqlalchemy_store +.. automodule:: apscheduler.jobstores.sqlalchemy Module Contents --------------- diff --git a/docs/modules/scheduler.rst b/docs/modules/scheduler.rst deleted file mode 100644 index 4adfb3e..0000000 --- a/docs/modules/scheduler.rst +++ /dev/null @@ -1,11 +0,0 @@ -:mod:`apscheduler.scheduler` -============================ - -.. automodule:: apscheduler.scheduler - -Module Contents ---------------- - -.. autoclass:: Scheduler - :members: -.. autoexception:: SchedulerAlreadyRunningError diff --git a/docs/modules/schedulers/asyncio.rst b/docs/modules/schedulers/asyncio.rst new file mode 100644 index 0000000..2b7b878 --- /dev/null +++ b/docs/modules/schedulers/asyncio.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.asyncio` +===================================== + +.. automodule:: apscheduler.schedulers.asyncio + +Module Contents +--------------- + +.. autoclass:: AsyncIOScheduler + :members: diff --git a/docs/modules/schedulers/background.rst b/docs/modules/schedulers/background.rst new file mode 100644 index 0000000..a85170c --- /dev/null +++ b/docs/modules/schedulers/background.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.background` +======================================== + +.. automodule:: apscheduler.schedulers.background + +Module Contents +--------------- + +.. autoclass:: BackgroundScheduler + :members: diff --git a/docs/modules/schedulers/base.rst b/docs/modules/schedulers/base.rst new file mode 100644 index 0000000..55d6075 --- /dev/null +++ b/docs/modules/schedulers/base.rst @@ -0,0 +1,11 @@ +:mod:`apscheduler.schedulers.base` +================================== + +.. automodule:: apscheduler.schedulers.base + +Module Contents +--------------- + +.. autoclass:: BaseScheduler + :members: +.. autoexception:: SchedulerAlreadyRunningError diff --git a/docs/modules/schedulers/blocking.rst b/docs/modules/schedulers/blocking.rst new file mode 100644 index 0000000..6bfbc3e --- /dev/null +++ b/docs/modules/schedulers/blocking.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.blocking` +====================================== + +.. automodule:: apscheduler.schedulers.blocking + +Module Contents +--------------- + +.. autoclass:: BlockingScheduler + :members: diff --git a/docs/modules/schedulers/gevent.rst b/docs/modules/schedulers/gevent.rst new file mode 100644 index 0000000..381c844 --- /dev/null +++ b/docs/modules/schedulers/gevent.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.gevent` +==================================== + +.. automodule:: apscheduler.schedulers.gevent + +Module Contents +--------------- + +.. autoclass:: GeventScheduler + :members: diff --git a/docs/modules/schedulers/qt.rst b/docs/modules/schedulers/qt.rst new file mode 100644 index 0000000..86be26a --- /dev/null +++ b/docs/modules/schedulers/qt.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.qt` +================================ + +.. automodule:: apscheduler.schedulers.qt + +Module Contents +--------------- + +.. autoclass:: QtScheduler + :members: diff --git a/docs/modules/schedulers/tornado.rst b/docs/modules/schedulers/tornado.rst new file mode 100644 index 0000000..a475d2e --- /dev/null +++ b/docs/modules/schedulers/tornado.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.tornado` +===================================== + +.. automodule:: apscheduler.schedulers.tornado + +Module Contents +--------------- + +.. autoclass:: TornadoScheduler + :members: diff --git a/docs/modules/schedulers/twisted.rst b/docs/modules/schedulers/twisted.rst new file mode 100644 index 0000000..843359f --- /dev/null +++ b/docs/modules/schedulers/twisted.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.schedulers.twisted` +===================================== + +.. automodule:: apscheduler.schedulers.twisted + +Module Contents +--------------- + +.. autoclass:: TwistedScheduler + :members: diff --git a/docs/modules/triggers/cron.rst b/docs/modules/triggers/cron.rst new file mode 100644 index 0000000..a722fa8 --- /dev/null +++ b/docs/modules/triggers/cron.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.triggers.cron` +================================ + +.. automodule:: apscheduler.triggers.cron + +Module Contents +--------------- + +.. autoclass:: CronTrigger + :members: diff --git a/docs/modules/triggers/date.rst b/docs/modules/triggers/date.rst new file mode 100644 index 0000000..fc9e5d7 --- /dev/null +++ b/docs/modules/triggers/date.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.triggers.date` +================================ + +.. automodule:: apscheduler.triggers.date + +Module Contents +--------------- + +.. autoclass:: DateTrigger + :members: diff --git a/docs/modules/triggers/interval.rst b/docs/modules/triggers/interval.rst new file mode 100644 index 0000000..daad38f --- /dev/null +++ b/docs/modules/triggers/interval.rst @@ -0,0 +1,10 @@ +:mod:`apscheduler.triggers.interval` +==================================== + +.. automodule:: apscheduler.triggers.interval + +Module Contents +--------------- + +.. autoclass:: IntervalTrigger + :members: |