api: document exceptions (#680)

cylc · Jan 30, 2024 · eb97348 · eb97348
1 parent 7b8d510
commit eb97348
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/src/conf.py b/src/conf.py
@@ -37,6 +37,8 @@
     'sphinx.ext.doctest',
     'sphinx.ext.graphviz',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
     'sphinxcontrib.spelling',
     # sphinx user community extensions
     'hieroglyph',
@@ -130,7 +132,10 @@
 nitpick_ignore = [
     # This class appears in documented type-hints but is not documented in the
     # Python docs so fails build.
-    ('py:class', 're.Pattern')
+    ('py:class', 're.Pattern'),
+    ('py:class', 'SubFuncContext'),
+    ('py:exc', 'ISO8601SyntaxError'),
+    ('py:exc', 'StrftimeSyntaxError'),
 ]
 
 # List of patterns, relative to source directory, that match files and

diff --git a/src/reference/api/exceptions.rst b/src/reference/api/exceptions.rst
@@ -0,0 +1,8 @@
+Exceptions
+==========
+
+.. automodule:: cylc.flow.exceptions
+   :members:
+
+.. automodule:: cylc.flow.parsec.exceptions
+   :members:
diff --git a/src/reference/api/index.rst b/src/reference/api/index.rst
@@ -3,6 +3,8 @@ Cylc API
 
 
 .. toctree::
+   :maxdepth: 2
 
    scan
    zmq
+   exceptions