📝 Document registration guardrails

docs/_sources/developer/qc.rst

@@ -0,0 +1,23 @@
+Quality Control
+===============
+
+.. automodule:: CPAC.qc
+    :members:
+
+.. automodule:: CPAC.qc.globals
+    :members:
+
+.. automodule:: CPAC.qc.pipeline
+    :members:
+
+.. automodule:: CPAC.qc.qc
+    :members:
+
+.. automodule:: CPAC.qc.qcmetrics
+    :members:
+
+.. automodule:: CPAC.qc.utils
+    :members:
+
+.. include:: /developer/xcpqc
+

docs/_sources/developer/workflows/registration.rst

@@ -2,5 +2,31 @@ Registration
 ============
 
 .. automodule:: CPAC.registration
-    :members:
+   :members:
 
+.. automodule:: CPAC.registration.registration
+   :members:
+
+Exceptions
+^^^^^^^^^^
+
+.. automodule:: CPAC.registration.exceptions
+   :members:
+
+Guardrails
+^^^^^^^^^^
+
+.. automodule:: CPAC.registration.guardrails
+   :members:
+
+Output_func_to_standard
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: CPAC.registration.output_func_to_standard
+   :members:
+
+Utils
+^^^^^
+
+.. automodule:: CPAC.registration.utils
+   :members:

docs/_sources/developer/xcpqc.rst

@@ -1,5 +1,5 @@
 eXtensible Connectivity Pipeline-style quality control files
-============================================================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: CPAC.qc.xcp
     :members:

docs/_sources/exec.py

@@ -6,8 +6,8 @@
 
 
 class ExecDirective(Directive):
-    """Execute the specified python code and insert the output into the document
-    """
+    """Execute the specified python code and insert the output into the
+    document"""
     has_content = True
 
     def run(self):
@@ -29,7 +29,10 @@ def run(self):
 
         try:
             exec('\n'.join(self.content))
-            return [nodes.literal_block(text=sys.stdout.getvalue())]
+            content = sys.stdout.getvalue()
+            if content.strip():
+                return [nodes.literal_block(text=content)]
+            return []
         except Exception as e:
             _, _, exc_tb = sys.exc_info()
             fname = os.path.split(exc_tb.tb_frame.f_code.co_filename)[1]
@@ -39,9 +42,7 @@ def run(self):
                 )
             )
             stack_message = nodes.paragraph(text=str(e))
-            return [
-                nodes.error(None, error_message, stack_message)
-            ]
+            return [nodes.error(None, error_message, stack_message)]
         finally:
             sys.stdout = oldStdout
             os.chdir(oldCwd)

docs/_sources/user/pipelines/quality.rst

@@ -5,4 +5,4 @@ Quality Control
    :maxdepth: 1
 
    QC Pages - Visual Data Quality Control </user/qc_interface>
-   XCP QC files - eXtensible Connectivity Pipeline-style quality control files </user/xcpqc>
+   Developer Documentation: Quality Control </user/qc>