odcs 0.8.0

Reference implementation of the Open Data Contract Standard (ODCS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

site_name: odcs
site_description: Reference implementation of the Open Data Contract Standard (ODCS)
site_url: https://odcs.readthedocs.io/
repo_url: https://github.com/eddiethedean/odcs
repo_name: eddiethedean/odcs
edit_uri: edit/main/docs/

docs_dir: docs

theme:
  name: material
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - include-markdown

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - User guides:
      - What is ODCS?: user/what-is-odcs.md
      - Getting started: user/getting-started.md
      - Installation: user/installation.md
      - CLI: user/cli.md
      - Rust: user/rust.md
      - Python: user/python.md
      - API decision guide: user/api-guide.md
      - Authoring contracts: user/authoring.md
      - Diagnostics: user/diagnostics.md
      - CI/CD integration: user/ci-cd.md
      - Migration: user/migration.md
      - FAQ: user/faq.md
      - Troubleshooting: user/troubleshooting.md
      - Glossary: user/glossary.md
      - Enterprise evaluation: user/enterprise-evaluation.md
  - Tutorials:
      - Fix your first invalid contract: user/tutorials/fix-invalid-contract.md
  - Examples: examples.md
  - Project:
      - Release status: project/release-status.md
      - Changelog: changelog.md
      - Roadmap: roadmap.md
      - Upstream sync policy: upstream-sync-policy.md
      - ODCS standard (bitol-io): https://bitol-io.github.io/open-data-contract-standard/
  - Implementation:
      - Overview: implementation/overview.md
      - Project goal: implementation/project-goal.md
      - Architecture: implementation/architecture.md
      - Crate layout: implementation/crate-layout.md
      - Model guide: implementation/model-guide.md
      - Validation guide: implementation/validation-guide.md
      - Cross-file references: implementation/cross-file-references.md
      - Diagnostics guide: implementation/diagnostics-guide.md
      - Public API: implementation/public-api.md
      - CLI specification: implementation/cli-spec.md
      - Implementation phases: implementation/implementation-phases.md
      - Testing plan: implementation/testing-plan.md
      - Rust dependencies: implementation/rust-dependencies.md
      - Spec usage: implementation/spec-usage.md
      - Non-goals: implementation/non-goals.md
      - Relationship to DTCS: implementation/relationship-to-dtcs.md
  - Contributing: contributing.md
  - Maintainer:
      - Releasing: maintainer/releasing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/eddiethedean/odcs
    - icon: fontawesome/brands/rust
      link: https://docs.rs/odcs
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyodcs/

validation:
  nav:
    omitted_files: warn
    not_found: warn
  links:
    # Maintainer docs link to src/, tests/, and repo-root files outside docs_dir.
    not_found: ignore
    unrecognized_links: ignore
    absolute_links: warn