geospatial-tools/properdocs.yml at main · RolnickLab/geospatial-tools · 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
site_name: Geospatial Tools
site_description: A package contain classes and utilities to help with geospatial data
repo_url: https://github.com/RolnickLab/geospatial-tools

docs_dir: docs/properdocs
nav:
  - User Guide:
      - sections/user-guide/user-guide.md
      - sections/user-guide/notebook-examples.md

  - Developer Guide: reference/

theme:
  name: material
  features:
    - content.code.copy
    - toc.follow
    - navigation.tracking

  palette:
    - media: "(prefers-color-scheme)"
      primary: deep orange
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

        # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to system preference


markdown_extensions:
  - admonition
  - toc:
        permalink: "#"
        toc_depth: 3

extra_css:
  - css/extra.css

plugins:
  - search
  - gen-files:
        scripts:
          - docs/properdocs/scripts/gen_ref_pages.py
  - literate-nav
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            inherited_members: true
            docstring_style: google
            members_order: source
            annotations_path: brief
            show_docstring_attributes: true
            modernize_annotations: true
            show_source: true
            show_submodules: true
            separate_signature: true
            signature_crossrefs: true
            show_signature_annotations: true
            allow_inspection: true
            show_symbol_type_heading: false
            show_symbol_type_toc: true
            line_length: 88
            merge_init_into_class: true