dissmodel/mkdocs.yml at main · DisSModel/dissmodel · 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
site_name: DisSModel
site_url: https://lambdageo.github.io/dissmodel/
repo_url: https://github.com/DisSModel/dissmodel
repo_name: dissmodel

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
  - mkdocs-jupyter:
      include: ["*.ipynb"]

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: teal
      accent: green


markdown_extensions:
  - codehilite
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Why DisSModel?: why_dissmodel.md
  - Examples: examples.md


  - API Reference:
    - Core: api/core.md
    - Geo:
      - Overview: api/geo/index.md
      - Vector: api/geo/vector.md
      - Raster: api/geo/raster.md
    - Executor:
      - Overview: api/executor/index.md
      - Schemas: api/executor/schemas.md
      - CLI: api/executor/cli.md
      - Testing: api/executor/testing.md
    - IO: api/io/index.md
    - Visualization: api/visualization.md