python-party/mkdocs.yml at main · DeepBlueCLtd/python-party · 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
site_name: Acoustic Reference Book — Phase 1 Pipeline Docs
site_description: >-
  Schema-driven XML Acoustic Dataset pipeline — a learning- and decision-oriented
  documentation set that grows with understanding.
docs_dir: docs
# Build into a gitignored folder; the HTML is a generated artifact.
site_dir: site

# The ADRs (decisions/) and the ADR how-to are kept in the repo for the decision
# record, but excluded from the published site. They remain browsable on GitHub.
exclude_docs: |
  decisions/
  how-to/add-a-decision-record.md

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true
  - tables

nav:
  - Home: index.md
  - Onboarding: onboarding.md
  - Typed data, end to end: concepts/typed-vs-dicts.md
  - Tutorials:
      - Start here (zero to green): tutorials/01-start-here.md
  - How-to guides:
      - Use the Codespace: how-to/use-the-codespace.md
      - Build the docs site: how-to/build-the-docs-site.md
      - Change the schema: how-to/change-the-schema.md
      - Run the migration-safety comparison: how-to/run-the-migration-safety-comparison.md
  - Concepts:
      - Schema as the contract: concepts/schema-as-contract.md
      - Typed data, end to end: concepts/typed-vs-dicts.md
      - The two verification gates: concepts/two-verification-gates.md
      - Pipeline data flow (ERD): concepts/pipeline-data-flow.md
  # ^ "Typed data, end to end" is also surfaced as a top-level nav item above for prominence.
  - Reference:
      - Overview: reference/index.md
      - Commands: reference/commands.md
      - Schema reference (generated): reference/schema/index.md
  - Glossary: glossary.md