agribound/mkdocs.yml at main · montimaj/agribound · 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
site_name: Agribound
site_description: Unified agricultural field boundary delineation from satellite imagery using geospatial foundation models, pre-trained segmentation, and embeddings.
site_url: https://montimaj.github.io/agribound
repo_url: https://github.com/montimaj/agribound
repo_name: montimaj/agribound

theme:
  name: material
  palette:
    - scheme: default
      primary: green
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - blog:
      blog_dir: blog
      post_date_format: long
      post_readtime: true
      archive: true
      categories: true
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: numpy
            show_signature_annotations: true
            separate_signature: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide:
      - Quickstart: user-guide/quickstart.md
      - Satellite Sources: user-guide/satellite-sources.md
      - Delineation Engines: user-guide/engines.md
      - Configuration Reference: user-guide/configuration.md
      - CLI Usage: user-guide/cli.md
      - GEE Setup: user-guide/gee-setup.md
      - Fine-Tuning: user-guide/fine-tuning.md
  - API Reference:
      - Pipeline: api/pipeline.md
      - Configuration: api/config.md
      - Composites: api/composites.md
      - Engines: api/engines.md
      - Post-Processing: api/postprocess.md
      - I/O Utilities: api/io.md
      - Evaluation: api/evaluate.md
      - Visualization: api/visualize.md
  - Gallery: gallery.md
  - Blog: blog/index.md
  - Contributing: contributing.md
  - Citation & References: citation.md