Skip to content

Commit a16b3a1

Browse files
committed
📝 Document schema in developer docs
1 parent 2ac49d3 commit a16b3a1

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

docs/_sources/developer/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Contents:
1414
:maxdepth: 2
1515

1616
installation
17+
pipeline
1718
nodes
1819
workflow_documentation
1920
workflows/index
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Pipeline Development
2+
====================
3+
4+
.. include:: /developer/schema.rst

docs/_sources/developer/schema.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _validation_schema:
2+
3+
*****************
4+
Validation Schema
5+
*****************
6+
7+
C-PAC uses `voluptuous <alecthomas.github.io/voluptuous/docs/_build/html>`_ to validate pipeline configurations against defined types and value restrictions. Default values should be set in :doc:`the default pipeline </user/pipelines/default>` along with comments explaining each option.

0 commit comments

Comments
 (0)