bridge-classification/mkdocs.yml at main · NOAA-OWP/bridge-classification · 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
site_name: Bridge Classification
site_description: USGS LiDAR Bridge Point Cloud Classification Pipeline
repo_url: https://github.com/NGWPC/bridge-classification
repo_name: NGWPC/bridge-classification

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Data Pipeline: data-pipeline.md
  - AWS Batch Inference: aws-batch-inference.md
  - Deployment Runbook: deployment-runbook.md
  - API Reference:
    - api/index.md
    - Core & Constants: api/core.md
    - Data I/O & Processing: api/data-io.md
    - Weak Supervision: api/weak-supervision.md
    - Model & Training: api/model-training.md
    - Inference & Cloud: api/inference-cloud.md
    - Utility Scripts: api/utils.md
  - Notebooks:
    - Dataset Overview: notebooks/dataset_overview.ipynb
    - RANSAC Deck Planes: notebooks/ransac_deck_planes.ipynb
    - Training Plots: notebooks/training_plots.ipynb
  - Design Decisions: decisions.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            heading_level: 2
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            members_order: source
  - mkdocs-jupyter:
      execute: false
      include_source: true

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