scistack/mkdocs.yml at main · mtillman14/scistack · 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
site_name: SciStack
site_description: Scientific Data Versioning Framework
site_url: https://scistack.readthedocs.io

repo_name: scistack
repo_url: https://github.com/mtillman14/scistack

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  features:
    # Top-level areas render as header tabs; the left sidebar is scoped to the
    # active tab and uses collapsible dropdowns. This replaces navigation.sections
    # + navigation.expand, which rendered the whole tree flat and force-expanded.
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quickstart: quickstart.md
    - Choosing Your Layer: getting-started/choosing-a-layer.md
    - MATLAB Setup: matlab-setup.md
  - Concepts:
    - concepts/index.md
    - Architecture & Layers: concepts/architecture.md
    - Variables & Storage: concepts/variables.md
    - Lineage & Provenance: concepts/lineage.md
    - Computation Caching: concepts/caching.md
    - Node States: concepts/node-states.md
    - Versioning & Content Hashing: concepts/hashing.md
    - Glossary: concepts/glossary.md
  - User Guide:
    - guide/index.md
    - Defining Variables: guide/variables.md
    - Database & Configuration: guide/database.md
    - Tracking Lineage: guide/lineage.md
    - Caching Computations: guide/caching.md
    - Batch Processing (for_each): guide/for_each.md
    - Filtering & Selection: guide/filters.md
    - Browsing & Exporting: guide/browsing.md
    - Inspecting a Database (scidb CLI): guide/inspect.md
  - Walkthroughs:
    - VO2 Max Pipeline: guide/walkthrough.md
  - API Reference:
    - api/index.md
    - Variables (BaseVariable): api/variables.md
    - Database: api/database.md
    - Lineage & Provenance: api/lineage.md
    - Batch Processing (for_each): api/for-each.md
    - Filters: api/filters.md
  - Internals:
    - internals/index.md
    - Lineage Engine (scilineage): internals/scilineage.md
    - DuckDB Layer (sciduckdb): internals/sciduckdb.md
    - Content Hashing (scicanonicalhash): internals/scicanonicalhash.md
    - Path Generation (scipathgen): internals/scipathgen.md
    - MATLAB Bridge (scimatlab): internals/scimatlab.md
    - Networking (scidb-net): internals/scidb-net.md
  - Project:
    - project/index.md
    - Roadmap: project/roadmap.md
    - Contributing & Dev Setup: project/contributing.md
    - Building These Docs: project/building-docs.md
    - FAQ & Troubleshooting: project/faq.md

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables

plugins:
  - search

# Internal engineering notes: kept in the repo but excluded from the published
# site (they were never in nav).
exclude_docs: |
  claude/