docs: add documentation for Jobs

2 files changed, 29 insertions, 0 deletions

diff --git a/docs/api/main.rst b/docs/api/main.rst
index 6febc61..e847e40 100644
--- a/docs/api/main.rst
+++ b/docs/api/main.rst
@@ -213,3 +213,10 @@ but not intended to be created explicitly.
         dictionary to interpret the image correctly. pikepdf automatically
         packages inline images into a more useful class, so this will not
         generally appear.
+
+Jobs
+====
+
+.. autoclass:: pikepdf.Job
+    :members:
+    :special-members: __init__
\ No newline at end of file
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 6cd0209..3c00f00 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -247,6 +247,28 @@ specify restrictions.
 Refer to our :ref:`security documentation <security>` for more information on
 user/owner passwords and PDF permissions.
 
+Running QPDF through Jobs
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+pikepdf can access all of the features of the qpdf command line program, and
+can even execute qpdf-like command lines.
+
+.. ipython::
+    :verbatim:
+
+    In [1]: from pikepdf import Job
+
+    In [1]: Job(['pikepdf', '--check', '../tests/resources/fourpages.pdf'])
+
+You can also specify jobs in QPDF Job JSON:
+
+.. ipython::
+    :verbatim:
+
+    In [1]: job_json = {'inputFile': '../tests/resources/fourpages.pdf', 'check': ''}
+
+    In [1]: Job(job_json).run()
+
 Next steps
 ----------