Skip to content
This repository was archived by the owner on Jun 5, 2023. It is now read-only.

Convert documentation to a sphinx-friendly format, and add a lot more of it. #144

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions docs/source/class.rst
Original file line number Diff line number Diff line change
@@ -1,28 +0,0 @@
.. module:: pyres

ResQ Classes
==========================================

.. autoclass:: pyres.ResQ
:members:

Job Classes
=================

.. autoclass:: pyres.job.Job
:members:

Worker Classes
=================

.. autoclass:: pyres.worker.Worker
:members:

Failure Classes
=================

.. autoclass:: pyres.failure.base.BaseBackend
:members:

.. autoclass:: pyres.failure.RedisBackend
:members:
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

# The encoding of source files.
#source_encoding = 'utf-8'

autoclass_content = 'both'
# The master toctree document.
master_doc = 'index'

Expand Down
18 changes: 18 additions & 0 deletions docs/source/failure_example.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Failure Example
===============

Pyres provides a ``BaseBackend`` for handling failed jobs. You can subclass
this backend to store failed jobs in any system you like.

Currently, the only provided backend is a ``RedisBackend`` which will store
your failed jobs into a special *failed* queue for later processing or
reenqueueing.

Here's a simple example::

>>> from pyres import failure
>>> from pyres.job import Job
>>> from pyres import ResQ
>>> r = ResQ()
>>> job = Job.reserve('basic', r)
>>> job.fail('problem')
26 changes: 12 additions & 14 deletions docs/source/failures.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
Failures
===============
.. module:: pyres

Pyres provides a ``BaseBackend`` for handling failed jobs. You can subclass
this backend to store failed jobs in any system you like.
Failure Classes
=================

Currently, the only provided backend is a ``RedisBackend`` which will store
your failed jobs into a special *failed* queue for later processing or
reenqueueing.
.. autoclass:: pyres.failure.base.BaseBackend
:members:

.. autoclass:: pyres.failure.redis.RedisBackend
:members:

Here's a simple example::
.. autoclass:: pyres.failure.multiple.MultipleBackend
:members:

>>> from pyres import failure
>>> from pyres.job import Job
>>> from pyres import ResQ
>>> r = ResQ()
>>> job = Job.reserve('basic', r)
>>> job.fail('problem')
.. autoclass:: pyres.failure.mail.MailBackend
:members:
21 changes: 12 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Welcome to pyres's documentation!
Contents:

.. toctree::
:maxdepth: 2

intro
install
example
class
tests
failures
horde
:maxdepth: 2

intro
install
example
resq
job
workers
failures
failure_example
tests
horde


Indices and tables
Expand Down
7 changes: 7 additions & 0 deletions docs/source/job.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. module:: pyres

Job Classes
=================

.. autoclass:: pyres.job.Job
:members:
7 changes: 7 additions & 0 deletions docs/source/resq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. module:: pyres

The ResQ Class
==========================================

.. autoclass:: pyres.ResQ
:members:
7 changes: 7 additions & 0 deletions docs/source/workers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. module:: pyres

Worker Classes
=================

.. autoclass:: pyres.worker.Worker
:members:
Loading