neat/mkdocs.yml at main · cognitedata/neat · GitHub

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
site_name: NEAT
docs_dir: docs
use_directory_urls: false
theme:
  name: material
  features:
    - content.code.copy
    - content.tooltips
  logo: artifacts/figs/logo.png
  favicon: artifacts/figs/logo.png
  palette:
    primary: indigo

nav:
  - Home: index.md
  - Getting Started: installation.md
  - Validations:
      - Ai_Readiness (NEAT-DMS-AI-READINESS): validation/index.html#ai_readiness-neat-dms-ai-readiness
      - Connections (NEAT-DMS-CONNECTIONS): validation/index.html#connections-neat-dms-connections
      - Consistency (NEAT-DMS-CONSISTENCY): validation/index.html#consistency-neat-dms-consistency
      - Containers (NEAT-DMS-CONTAINER): validation/index.html#containers-neat-dms-container
      - Limits (NEAT-DMS-LIMITS): validation/index.html#limits-neat-dms-limits
      - Performance (NEAT-DMS-PERFORMANCE): validation/index.html#performance-neat-dms-performance
      - Views (NEAT-DMS-VIEW): validation/index.html#views-neat-dms-view
  - Data Modeling:
      - Principles: data_modeling/principles.md
      - Modes: data_modeling/modes.md
      - Data Modeling in Excel:
        - Overview: data_modeling/excel/data_model.md
        - Physical Data Model:
            - Overview: data_modeling/excel/physical/overview.md
            - Reference: data_modeling/excel/physical/reference.md
            - Properties: data_modeling/excel/physical/properties.md
            - Views: data_modeling/excel/physical/views.md
            - Enum: data_modeling/excel/physical/enum.md
            - Units: data_modeling/excel/physical/units.md
  - Tutorials:
    - Introduction: tutorials/introduction.ipynb
  - Reference:
    - NeatSession: reference/session.md
    - NeatConfig: reference/config.md
  - Known Issues: known_issues.md
  - About:
    - History: history.md
    - Authors: authors.md
    - Changelog: https://github.com/cognitedata/neat/releases


  - Legacy Docs (v0.x):
    - Tutorials:
        - Introduction:
            - Introduction: tutorials/legacy/introduction/introduction.ipynb
        - Data Modeling:
          - My First Data Model: tutorials/legacy/data-modeling/cold_start.ipynb
          - From Conceptual to Physical Data Modeling: tutorials/legacy/data-modeling/from-conceptual-to-physical-via-CDM.ipynb
    - NeatSession:
        - Session: reference/legacy/NeatSession/base.md
        - Read: reference/legacy/NeatSession/read.md
        - Template: reference/legacy/NeatSession/template.md
        - Prepare: reference/legacy/NeatSession/prepare.md
        - Fix: reference/legacy/NeatSession/fix.md
        - Mapping: reference/legacy/NeatSession/mapping.md
        - Set: reference/legacy/NeatSession/set.md
        - Subset: reference/legacy/NeatSession/subset.md
        - To: reference/legacy/NeatSession/to.md
        - Inspect: reference/legacy/NeatSession/inspect.md
        - Show: reference/legacy/NeatSession/show.md
        - Drop: reference/legacy/NeatSession/drop.md

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - abbr
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: "#"

plugins:
  - mkdocs-jupyter:
      execute: false
      ignore_h1_titles: True
      include_source: True
      remove_tag_config:
        remove_input_tags:
          - hide
  - glightbox:
      width: 100%
      height: auto
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: true
            show_source: false
            members_order: source
  - autorefs
  - search