mkdocs.yml

site_name: dppvalidator
site_description: Python library for validating Digital Product Passports (DPP) according to EU ESPR regulations and CIRPASS/UNECE ontologies
site_url: https://artiso-ai.github.io/dppvalidator
repo_url: https://github.com/artiso-ai/dppvalidator
repo_name: artiso-ai/dppvalidator
edit_uri: edit/main/docs/

# Exclude engineering artefacts from the docs build. The migration plans
# under docs/plans/ are change-tracking documents (implementation logs,
# audit notes, tracking issues); they're not part of the user-facing
# docs site and contain cross-tree relative links to src/ and tests/
# that mkdocs (rightly) flags as broken in strict mode.
exclude_docs: |
  plans/
copyright: >
  Copyright &copy; 2026 artiso-ai - <a href="#__consent">Change cookie
  settings</a>

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/favicon-32x32.png
  palette:
    - scheme: default
      primary: grey
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: grey
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

plugins:
  - search
  - meta
  - social
  - privacy
  - mkdocstrings:
      handlers:
        python:
          paths: [ src ]
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            docstring_style: google

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      # Force a non-None ``title`` for every code block. Without
      # this, ``pymdownx.highlight`` passes ``filename=None`` to
      # pygments' ``HtmlFormatter``, which crashes with
      # ``AttributeError: 'NoneType' object has no attribute 'replace'``
      # under pygments >=2.20.0 (the latter tightened None handling
      # in ``html.escape(self._decodeifneeded(...))``). Enabling
      # ``auto_title`` makes pymdownx fill ``title`` from the lexer
      # name when the markdown didn't set one. Tracked upstream as a
      # pymdown-extensions / pygments compatibility issue.
      auto_title: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format ""
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: ['.', 'docs']
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji ""
      emoji_generator: !!python/name:material.extensions.emoji.to_svg ""
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    provider: google
    property: G-CYYCRW64JY # Replace with your Google Analytics 4 Measurement ID
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Thanks for your feedback! Help us improve by opening an issue.
  consent:
    title: Cookie consent
    description: >
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better. For more information, see our <a
      href="https://artiso.ai/privacy-policy" target="_blank">Privacy
      Policy</a>.
    cookies:
      analytics:
        name: Google Analytics
        checked: true
    actions:
      - accept
      - reject
      - manage
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/artiso-ai/dppvalidator
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dppvalidator/
    - icon: fontawesome/brands/linkedin
      link: https://es.linkedin.com/company/artiso-ai
    - icon: fontawesome/solid/globe
      link: https://artiso.ai/

nav:
  - Home: index.md
  - Getting Started:
      - Introduction: getting-started/introduction.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Guides:
      - CLI Usage: guides/cli-usage.md
      - Validation: guides/validation.md
      - Use Cases: guides/use-cases.md
      - JSON-LD Export: guides/jsonld.md
      - EU DPP Export: guides/eudpp-export.md
      - Migration 0.6 → 0.7: guides/migration-0-6-to-0-7.md
      - Migrate UNTP → CIRPASS: guides/migrate-untp-to-cirpass.md
      - Plugin Development: guides/plugins.md
  - Reference:
      - CLI Reference: reference/cli.md
      - CLI Exit Codes: reference/cli/exit-codes.md
      - API:
          - Models: reference/api/models.md
          - Validators: reference/api/validators.md
          - Exporters: reference/api/exporters.md
          - Plugins: reference/api/plugins.md
      - CIRPASS Models: reference/cirpass/index.md
  - Concepts:
      - CIRPASS-2 Alignment: concepts/cirpass-2-alignment.md
      - CIRPASS-2 Spec Snapshot: concepts/cirpass-2-spec-snapshot.md
      - EUDPP v1.9 Changelog: concepts/eudpp-1.9-changelog.md
      - UNTP ↔ CIRPASS Mapping: concepts/untp-cirpass-mapping.md
      - UNTP DPP versions: concepts/untp-versions.md
      - UNTP DPP Schema: concepts/untp-schema.md
      - Five-Layer Validation: concepts/validation-layers.md
      - EU DPP Ontology Alignment (legacy): concepts/eudpp-ontology-alignment.md
      - CIRPASS-2 Implementation (legacy): concepts/cirpass-implementation.md
  - Plugins:
      - Overview: plugins.md
      - Tyres (Pre-1.0): plugins/tyres.md
  - Contributing:
      - Development Setup: contributing/development-setup.md
      - Security Setup: contributing/SECURITY_SETUP.md
      - Code Style: contributing/code-style.md
      - Testing: contributing/testing.md
  - Errors:
      - Overview: errors/index.md
      - Schema Errors:
          - SCH001 - Schema Not Loaded: errors/SCH001.md
          - SCH002 - Type Mismatch: errors/SCH002.md
          - SCH003 - Invalid Enum Value: errors/SCH003.md
          - SCH004 - Invalid Format: errors/SCH004.md
          - SCH005 - Pattern Mismatch: errors/SCH005.md
          - SCH006 - String Too Short: errors/SCH006.md
          - SCH007 - String Too Long: errors/SCH007.md
          - SCH008 - Value Below Minimum: errors/SCH008.md
          - SCH009 - Value Above Maximum: errors/SCH009.md
          - SCH010 - Additional Properties: errors/SCH010.md
          - SCH011 - Too Few Items: errors/SCH011.md
          - SCH012 - Too Many Items: errors/SCH012.md
          - SCH013 - Duplicate Items: errors/SCH013.md
          - SCH014 - Const Mismatch: errors/SCH014.md
          - SCH015 - AllOf Violation: errors/SCH015.md
          - SCH016 - AnyOf Violation: errors/SCH016.md
          - SCH017 - OneOf Violation: errors/SCH017.md
          - SCH018 - Not Violation: errors/SCH018.md
          - SCH019 - Contains Violation: errors/SCH019.md
          - SCH020 - PrefixItems Violation: errors/SCH020.md
          - SCH021 - Reference Resolution: errors/SCH021.md
          - SCH099 - Unknown Schema Error: errors/SCH099.md
      - Parsing Errors:
          - PRS001 - File Not Found: errors/PRS001.md
          - PRS002 - Invalid JSON: errors/PRS002.md
          - PRS003 - Unsupported Input Type: errors/PRS003.md
          - PRS004 - Input Too Large: errors/PRS004.md
          - PRS005 - File Size Exceeded: errors/PRS005.md
      - Model Errors:
          - MDL001 - Model Validation Failed: errors/MDL001.md
          - MDL002 - Invalid URL Format: errors/MDL002.md
          - MDL003 - Invalid DateTime Format: errors/MDL003.md
          - MDL010 - Invalid Issuer: errors/MDL010.md
          - MDL011 - Invalid Issuer ID: errors/MDL011.md
          - MDL012 - Invalid Issuer Name: errors/MDL012.md
          - MDL013 - Invalid Issuer Type: errors/MDL013.md
          - MDL014 - Invalid Issuer Location: errors/MDL014.md
          - MDL015 - Invalid Issuer Identifier: errors/MDL015.md
          - MDL016 - Invalid Identifier Scheme: errors/MDL016.md
          - MDL020 - Invalid Credential Subject: errors/MDL020.md
          - MDL021 - Invalid Credential Subject ID: errors/MDL021.md
          - MDL022 - Invalid Credential Subject Type: errors/MDL022.md
          - MDL030 - Invalid Product: errors/MDL030.md
          - MDL031 - Invalid Product ID: errors/MDL031.md
          - MDL032 - Invalid Product Name: errors/MDL032.md
          - MDL033 - Invalid Product Category: errors/MDL033.md
          - MDL040 - Invalid Material: errors/MDL040.md
          - MDL041 - Invalid Material Name: errors/MDL041.md
          - MDL042 - Invalid Material Fraction: errors/MDL042.md
          - MDL050 - Invalid Claim: errors/MDL050.md
          - MDL051 - Invalid Claim Type: errors/MDL051.md
          - MDL052 - Invalid Claim Topic: errors/MDL052.md
          - MDL053 - Invalid Claim Assessment: errors/MDL053.md
          - MDL060 - Invalid Traceability: errors/MDL060.md
          - MDL061 - Invalid Traceability Event: errors/MDL061.md
          - MDL070 - Invalid Circularity: errors/MDL070.md
          - MDL071 - Invalid Circularity Content: errors/MDL071.md
          - MDL080 - Invalid Emission: errors/MDL080.md
          - MDL081 - Invalid Emission Value: errors/MDL081.md
          - MDL090 - Invalid Facility: errors/MDL090.md
          - MDL091 - Invalid Facility Location: errors/MDL091.md
          - MDL098 - No Model Registered for Schema Version: errors/MDL098.md
          - MDL099 - Unknown Model Error: errors/MDL099.md
      - JSON-LD Errors:
          - JLD001 - Missing Context: errors/JLD001.md
          - JLD002 - Undefined Terms: errors/JLD002.md
          - JLD003 - Namespace Pollution: errors/JLD003.md
          - JLD004 - Context Resolution: errors/JLD004.md
      - Semantic Errors:
          - SEM001 - Mass Fraction Sum: errors/SEM001.md
          - SEM002 - Validity Date Order: errors/SEM002.md
          - SEM003 - Hazardous Material Safety: errors/SEM003.md
          - SEM004 - Circularity Consistency: errors/SEM004.md
          - SEM005 - Missing Conformity Claims: errors/SEM005.md
          - SEM006 - Item-Level Serial Number: errors/SEM006.md
          - SEM007 - Operational Scope: errors/SEM007.md
      - Vocabulary Errors:
          - VOC001 - Invalid Country Code: errors/VOC001.md
          - VOC002 - Invalid Unit Code: errors/VOC002.md
          - VOC003 - UNECE Material Code: errors/VOC003.md
          - VOC004 - HS Code Validation: errors/VOC004.md
          - VOC005 - GTIN Checksum: errors/VOC005.md
      - CIRPASS Errors:
          - CQ001 - Missing Mandatory Attributes: errors/CQ001.md
          - CQ004 - Missing CAS Number: errors/CQ004.md
          - CQ011 - Missing Operator ID: errors/CQ011.md
          - CQ016 - Missing Validity Period: errors/CQ016.md
          - CQ017 - Granularity Mismatch: errors/CQ017.md
          - CQ020 - Missing Weight/Volume: errors/CQ020.md
      - Textile Errors:
          - TXT001 - Invalid Textile HS Code: errors/TXT001.md
          - TXT002 - Missing Material Composition: errors/TXT002.md
          - TXT003 - Missing Microplastic Data: errors/TXT003.md
          - TXT004 - Missing Durability Info: errors/TXT004.md
          - TXT005 - Missing Care Instructions: errors/TXT005.md
          - TXT006 - Missing Recycled-Content Disclosure: errors/TXT006.md
          - TXT007 - Missing Repair Information: errors/TXT007.md
      - Party-Role Errors:
          - PRT001 - PartyRole Acceptance Gradient: errors/PRT001.md
      - Version Errors:
          - VER001 - UNTP Version Mismatch: errors/VER001.md
      - Upgrade-shim Errors:
          - UPG001 - Lossy Upgrade Transformation: errors/UPG001.md
          - UPG002 - Synthesised Value During Upgrade: errors/UPG002.md
          - UPG003 - Unmapped Country Code: errors/UPG003.md
          - UPG004 - Required v0.7 Field Missing: errors/UPG004.md
      - Detection Errors:
          - DET001 - Family Mismatch: errors/DET001.md
      - Mapping Errors:
          - MAP001 - Lossy Mapping Transformation: errors/MAP001.md
          - MAP002 - Synthesised Value During Mapping: errors/MAP002.md
          - MAP003 - Unmapped Field Passthrough: errors/MAP003.md
          - MAP004 - Required Field Missing on Target: errors/MAP004.md
          - MAP005 - Temporal Collapse: errors/MAP005.md
  - Architecture Decisions:
      - Overview: adr/README.md
      - 0001 - CIRPASS JSON Schema Derivation: adr/0001-cirpass-json-schema-derivation.md
      - 0002 - Canonical EUDPP IRI: adr/0002-canonical-eudpp-iri.md
      - 0003 - Tyre License: adr/0003-tyre-license.md
      - 0004 - Textile v2 Built-in: adr/0004-textile-v2-built-in.md
      - 0005 - CLI Exit Codes: adr/0005-cli-exit-codes.md
      - 0006 - Validation Layer Taxonomy: adr/0006-validation-layer-taxonomy.md
  - FAQ: faq.md
  - Changelog: changelog.md