DePSI/mkdocs.yml at main · TUDelftGeodesy/DePSI · 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: "DePSI: Delft PS-InSAR processing package"
site_url: https://tudelftgeodesy.github.io/DePSI_group
repo_url: https://github.com/TUDelftGeodesy/DePSI_group
repo_name: DePSI_group

nav:
  - About DePSI: index.md
  - Install DePSI: installation.md
  - API Reference:
    - depsi.classification: api/classification.md
    - depsi.arc_estimation: api/arc_estimation.md
    - depsi.network: api/network.md
    - depsi.atmosphere_estimation: api/atmosphere_estimation.md
    - depsi.densification: api/densification.md
    - depsi.transformations: api/transformations.md
    - depsi.io: api/io.md
  - Contributing:
    - Contributing guide: CONTRIBUTING.md
    - Practical info for developers: dev_guide.md
    - Code of conduct: CODE_OF_CONDUCT.md
  - Example Notebooks:
    - DePSI example workflow: notebooks/demo_depsi_full.ipynb
    - SARXarray and STMTools Dependencies of DePSI: notebooks/demo_sarxarray_and_stmtools.ipynb


theme:
  name: material
  custom_dir: docs/notebooks/download_button
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: blue
      accent: white

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: black
      accent: pink
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy

plugins:
- mkdocs-jupyter:
      include_source: True
- search
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: numpy
          docstring_options:
            ignore_init_summary: no
          merge_init_into_class: yes
          show_submodules: no

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences

extra:
  generator: false
  version:
    provider: mike