Included hscommon.jobprogress in the devdocs

arsenetar · Oct 5, 2014 · 4426627 · 4426627
1 parent ac32305
commit 4426627
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 10 deletions.
diff --git a/help/conf.tmpl b/help/conf.tmpl
@@ -25,7 +25,7 @@ sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
 
 def fix_nulljob_in_sig(app, what, name, obj, options, signature, return_annotation):
     if signature:
-        signature = re.sub(r"<jobprogress.job.NullJob object at 0x[\da-f]+>", "nulljob", signature)
+        signature = re.sub(r"<hscommon.jobprogress.job.NullJob object at 0x[\da-f]+>", "nulljob", signature)
     return signature, return_annotation
 
 def setup(app):

diff --git a/help/en/developer/hscommon/index.rst b/help/en/developer/hscommon/index.rst
@@ -3,17 +3,14 @@ hscommon
 
 .. toctree::
     :maxdepth: 2
+    :glob:
 
     build
     conflict
     desktop
     notify
     path
     util
-    gui/base
-    gui/text_field
-    gui/selectable_list
-    gui/table
-    gui/tree
-    gui/column
-    gui/progress_window
+    jobprogress/*
+    gui/*
+
diff --git a/help/en/developer/hscommon/jobprogress/job.rst b/help/en/developer/hscommon/jobprogress/job.rst
@@ -0,0 +1,17 @@
+hscommon.jobprogress.job
+========================
+
+.. automodule:: hscommon.jobprogress.job
+
+    .. autosummary::
+
+        Job
+        NullJob
+
+    .. autoclass:: Job
+        :members:
+        :private-members:
+
+    .. autoclass:: NullJob
+        :members:
+
diff --git a/help/en/developer/hscommon/jobprogress/performer.rst b/help/en/developer/hscommon/jobprogress/performer.rst
@@ -0,0 +1,12 @@
+hscommon.jobprogress.performer
+==============================
+
+.. automodule:: hscommon.jobprogress.performer
+
+    .. autosummary::
+
+        ThreadedJobPerformer
+
+    .. autoclass:: ThreadedJobPerformer
+        :members:
+
diff --git a/help/en/developer/hscommon/jobprogress/qt.rst b/help/en/developer/hscommon/jobprogress/qt.rst
@@ -0,0 +1,12 @@
+hscommon.jobprogress.qt
+=======================
+
+.. automodule:: hscommon.jobprogress.qt
+
+    .. autosummary::
+
+        Progress
+
+    .. autoclass:: Progress
+        :members:
+
diff --git a/hscommon/gui/progress_window.py b/hscommon/gui/progress_window.py
@@ -48,7 +48,7 @@ class ProgressWindow(GUIObject, ThreadedJobPerformer):
     :meth:`pulse` in the main thread because GUI toolkit usually only support calling UI-related
     functions from the main thread.
 
-    We subclass :class:`.GUIObject` and :class:`ThreadedJobPerformer`.
+    We subclass :class:`.GUIObject` and :class:`.ThreadedJobPerformer`.
     Expected view: :class:`ProgressWindowView`.
 
     :param finishfunc: A function ``f(jobid)`` that is called when a job is completed. ``jobid`` is
@@ -102,7 +102,7 @@ def pulse(self):
     def run(self, jobid, title, target, args=()):
         """Starts a threaded job.
 
-        The ``target`` function will be sent, as its first argument, a :class:`Job` instance which
+        The ``target`` function will be sent, as its first argument, a :class:`.Job` instance which
         it can use to report on its progress.
 
         :param jobid: Arbitrary identifier which will be passed to ``finish_func()`` at the end.