segment-geospatial/mkdocs.yml at main · opengeos/segment-geospatial · 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
site_name: segment-geospatial

site_url: https://samgeo.gishub.org

repo_url: https://github.com/opengeos/segment-geospatial

theme:
    palette:
        scheme: preference
    name: material
    icon:
        repo: fontawesome/brands/github
    features:
        - navigation.instant
        - search.highlight
        # - navigation.expand
        # - navigation.tabs
    custom_dir: "docs/overrides"

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - mkdocs-jupyter:
          include_source: True
          execute: False
          ignore_h1_titles: True
          #   execute_ignore: "*.ipynb"

markdown_extensions:
    - attr_list
    - pymdownx.superfences
    - pymdownx.highlight:
          linenums: true
    - toc:
          permalink: true

# extra:
#     analytics:
#         provider: google
#         property: UA-XXXXXXXXX-X

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - REST API: api.md
    - Contributing: contributing.md
    - FAQ: faq.md
    - Changelog: changelog.md
    - Report Issues: https://github.com/opengeos/segment-geospatial/issues
    - Examples:
          - examples/satellite.ipynb
          - examples/automatic_mask_generator.ipynb
          - examples/automatic_mask_generator_hq.ipynb
          - examples/input_prompts.ipynb
          - examples/input_prompts_hq.ipynb
          - examples/box_prompts.ipynb
          - examples/text_prompts.ipynb
          - examples/text_prompts_batch.ipynb
          - examples/fast_sam.ipynb
          - examples/text_swimming_pools.ipynb
          - examples/arcgis.ipynb
          - examples/maxar_open_data.ipynb
          - examples/sam2_automatic.ipynb
          - examples/sam2_predictor.ipynb
          - examples/sam2_video.ipynb
          - examples/sam2_box_prompts.ipynb
          - examples/sam2_point_prompts.ipynb
          - examples/sam2_text_prompts.ipynb
          - examples/tree_mapping.ipynb
          - examples/image_captioning.ipynb
          - examples/sam3_image_segmentation.ipynb
          - examples/sam3_image_segmentation_jpg.ipynb
          - examples/sam3_interactive.ipynb
          - examples/sam3_batch_segmentation.ipynb
          - examples/sam3_video_segmentation.ipynb
          - examples/sam3_video_prompts.ipynb
          - examples/sam3_video_masks.ipynb
          - examples/sam3_automated_segmentation.ipynb
          - examples/sam3_object_tracking.ipynb
          - examples/sam3_point_prompts.ipynb
          - examples/sam3_point_prompts_batch.ipynb
          - examples/sam3_box_prompts.ipynb
          - examples/sam3_tiled_segmentation.ipynb
          - examples/detectree2.ipynb
    - Workshops:
          - workshops/purdue.ipynb
          - workshops/cn_workshop.ipynb
          - workshops/IPPN_2024.ipynb
          - workshops/AIforGood_2025.ipynb
    - API Reference:
          - caption module: caption.md
          - common module: common.md
          - samgeo module: samgeo.md
          - samgeo2 module: samgeo2.md
          - samgeo3 module: samgeo3.md
          - fast_sam module: fast_sam.md
          - hq_sam module: hq_sam.md
          - text_sam module: text_sam.md
          - detectree2 module: detectree2.md
          - api module: api.md
          #   - fer module: fer.md