Use NumPy style docstrings.

changelog.txt

@@ -21,6 +21,7 @@ Changed
 +++++++
 - Command line interface always uses ``--job-id`` instead of ``--jobid`` (#363, #386).
 - ``CPUEnvironment`` and ``GPUEnvironment`` classes are deprecated (#381).
+- Docstrings are now written in `numpydoc style <https://numpydoc.readthedocs.io/en/latest/format.html>`__ (#392).
 
 Version 0.11
 ============

doc/api.rst

@@ -109,17 +109,33 @@ Operations and Status
 .. autoclass:: flow.project.FlowOperation
     :show-inheritance:
     :members:
+    :special-members: __call__
 
 .. autoclass:: flow.project.FlowCmdOperation
     :show-inheritance:
     :members:
+    :special-members: __call__
 
 .. autoclass:: flow.project.JobOperation
     :members:
 
 .. autoclass:: flow.render_status.Renderer
     :members: generate_terminal_output, generate_html_output, render
 
+Labels
+------
+
+.. autoclass:: flow.label
+    :members:
+    :special-members: __call__
+
+.. autoclass:: flow.staticlabel
+    :members:
+    :special-members: __call__
+
+.. autoclass:: flow.classlabel
+    :members:
+    :special-members: __call__
 
 @flow.cmd
 ---------
@@ -135,6 +151,8 @@ Operations and Status
 ----------------
 
 .. autoclass:: directives
+    :members:
+    :special-members: __call__
 
 flow.run()
 ----------
@@ -157,13 +175,18 @@ The FlowGroup
 .. autoclass:: flow.project.FlowGroup
     :members:
 
+.. autoclass:: flow.project.FlowGroupEntry
+    :members:
+    :special-members: __call__
+
 Aggregation
 -----------
 
 .. automodule:: flow.aggregates
 
 .. autoclass:: flow.aggregates.aggregator
     :members:
+    :special-members: __call__
 
 .. autofunction:: flow.aggregates.get_aggregate_id
 

doc/conf.py

@@ -20,6 +20,7 @@ class Mock(MagicMock):
 
     @classmethod
     def __getattr__(cls, name):
+        """Get mocked attribute."""
         if name == "_mock_methods":
             return []
         return Mock()
@@ -45,6 +46,7 @@ def __getattr__(cls, name):
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
 ]