Validate doc type data during build

documents/_data/doc-types.yaml

@@ -0,0 +1,135 @@
+# Many of these came from cloverDocumentControlRecords2010 originally
+# Other sources include IEC 631355 https://en.wikipedia.org/wiki/IEC_61355
+# and ANSI-N45-2-9-74 https://jetsquality.com/wp-content/uploads/2019/01/ANSI-N45-2-9-74.pdf
+# has like >100 record types nicely sorted into use case categories (Design, Procurement, Manufacture, ...)
+# I like these the best, but maybe they can be compressed with considering USAGE.
+
+- name: Calculation
+  abbrev: CALC
+  use_cases: Documenting an analysis
+  record: True
+  retention:
+- name: Design Report
+  abbrev: DREP
+  use_cases: Documenting a design
+  record: True
+  retention:
+- name: Design Review Report
+  abbrev: DREV
+  use_cases: Documenting the review of a design
+  record: True
+  retention:
+- name: System Design Description
+  abbrev: SDD
+  use_cases: Describing a system
+  record: True
+  retention:
+- name: Correspondence
+  abbrev: CSP
+  use_cases: Communications
+  record: False
+  retention:
+- name: Drawing
+  abbrev: DRW
+  use_cases: Describing SSCs, includes many engineering deliverables
+  record: True
+  retention:
+- name: Engineering Change Package
+  abbrev: ECP
+  use_cases: Describing a formal change to the system configuration
+  record: True
+  retention:
+- name: Equipment Data Sheets
+  abbrev: EDS
+  use_cases: Define technical requirements and operating boundaries
+  record: True
+  retention:
+- name: Environmental Qualification Package
+  abbrev: EQP
+  use_cases: >
+    Documents describing environmental qualifications of equipment such as 
+    lab reports, thermal aging analyses, radiation resistance data supporting
+    10 CFR 50.49
+  record: True
+  retention:
+- name: Form
+  abbrev: FORM
+  use_cases: A reusable starting point for other Documents/Records, or for collecting data
+  record: False
+  retention: Lifetime
+  notes: Forms are blank documents.
+- name: Instructions
+  abbrev: INSTR
+  use_cases: Explanations of how to use systems or equipment
+  record: True
+  retention:
+- name: Native File
+  abbrev: NTV
+  use_cases: A native file i.e. from a proprietary authoring software
+  record: False
+  notes: >
+    Native files are kept for ease of revision. They may also be kept as
+    additional file attachment alongside the document/record.
+- name: Policy
+  abbrev: POL
+  use_cases: A policy
+  record: True
+- name: Business Practice/Desk Guide
+  abbrev: BPDG
+  record: False
+- name: Procedure
+  abbrev: PROC
+  use_cases: Defining and dictating how work is done
+  record: True
+  retention: Lifetime
+- name: Procurement
+  abbrev: PCMT
+  use_cases: Related to purchases
+  record: True
+  retention: Lifetime
+- name: Program Manual/Plan
+  abbrev: PMAN
+  use_cases: >
+    High-level governance documents that describes how the plant will manage
+    a specific program area (e.g., Radiation Protection, In-Service
+    Inspection, or Fire Protection).
+  record: True
+  retention: Lifetime
+- name: Quality Classification List
+  abbrev: QLST
+  use_cases: Categorizes every SSC based on importance to safety
+  record: True
+  retention:
+- name: Radiation Protection Survey
+  abbrev: RPS
+  record: True
+  retention:
+- name: Records Transmittal Instructions/Indexing Guide
+  abbrev: RTI
+  record: True
+  retention:
+- name: Regulatory Documents
+  abbrev: REG
+  use_cases: Safety Analysis Report, Technical Specifications, etc.
+  record: True
+  retention:
+- name: Setpoints
+  abbrev: SET
+  record: True
+  retention:
+- name: Specifications
+  abbrev: SPEC
+  record: True
+  retention:
+- name: Training
+  abbrev: TRN
+  record: True
+  retention:
+- name: Vendor Drawings
+  abbrev: VDRW
+  record: True
+  retention:
+- name: Vendor Information
+  abbrev: VNFO
+  record: True
+  retention:

documents/_data/it-systems.yaml

@@ -4,11 +4,11 @@
 RMDC:
   - name: NukeVault
     description: Specialized commercial records management system
-    use-cases: Storing Documents and Records generated during design of Project X
+    use_cases: Storing Documents and Records generated during design of Project X
     location: https://nukevault.opennucleonics.org
   - name: Supplier Portal
     description: A place where our suppliers can get documents
-    use-cases: External suppliers send documents/records to us
+    use_cases: External suppliers send documents/records to us
     location: Online
 Data Management:
   - name: Data Dictionary

documents/conf.py

@@ -10,12 +10,14 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+import datetime
 import os
 import sys
 
 SRC = os.path.abspath("../src")
 sys.path.insert(0, SRC)
-import datetime
+
+from nrsk.documents.validate import validate_doc_types
 
 # -- Project information -----------------------------------------------------
 company_name = "Applied Maritime Sciences, LLC"
@@ -198,3 +200,7 @@ intersphinx_mapping = {
     "pydantic": ("https://docs.pydantic.dev/latest", None),
     "python": ("https://docs.python.org/3", None),
 }
+
+
+def setup(app):
+    app.connect("builder-inited", validate_doc_types)

documents/procedures/administration/doc-types.yaml

@@ -1,16 +0,0 @@
-- name: Calculation
-  abbrev: CALC
-  use-cases: Documenting an analysis
-  record: False
-  retention: Varies
-- name: Procedure
-  abbrev: PROC
-  use-cases: Defining and dictating how work is done
-  record: False
-  retention: Lifetime
-- name: Form
-  abbrev: FORM
-  use-cases: Providing evidence of tasks that were done
-  record: True
-  retention: Lifetime
-