sandpyper/mkdocs.yml at master · npucino/sandpyper · 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
site_name: Sandpyper

site_url: https://npucino.github.io/sandpyper/

repo_url: https://github.com//npucino//sandpyper

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

markdown_extensions:
    - admonition
    - codehilite
    - attr_list
    - pymdownx.superfences
    - pymdownx.highlight:
          linenums: true
    - pymdownx.arithmatex:
        generic: true
    - toc:
          permalink: true

extra_javascript:
  - javascripts/extra.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


# google_analytics:
#     - UA-XXXXXXXXX-X
#     - auto

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - Contributing: contributing.md
    - FAQ: faq.md
    - Report Issues: https://github.com//npucino//sandpyper//issues
    - Methods:
        - Introduction: Introduction.md
        - Elevation analysis: extraction and lod.md
        - Data cleaning: ML and SA.md
        - Hotspot analysis: hotspot_methods.md
        - BCDs: bcds_method.md
        - Volumetrics: volumetrics_method.md
    - API Reference:
      - sandpyper module: sandpyper.md
      - common module: common.md
    - Notebooks:
        - notebooks/1 - Introduction and data preparation.ipynb
        - notebooks/2 - Profiles extraction, unsupervised sand labelling and cleaning.ipynb
        - notebooks/3 - Profile dynamics.ipynb
        - notebooks/Space analysis - teaser.ipynb