propagator_sim/mkdocs.yml at main · vostpt/propagator_sim · 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

site_name: PROPAGATOR Sim
site_description: "PROPAGATOR: An Operational Cellular-Automata Based Wildfire Simulator"
site_url: ""

theme:
  name: material
  logo: img/cima.png
  features:
    - navigation.sections
    - navigation.indexes
    - navigation.instant
    - content.code.copy
    - toc.follow

extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Programmatic Workflow: programmatic.md
  - CLI Usage: cli.md
  - API Reference:
      - Overview: reference/index.md
      - Core: reference/propagator.md
      - I/O: reference/io.md
      - Numba Backend: reference/numba.md
  - Bibliography: bibliography.md


plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          # If you use the "src/" layout, point mkdocstrings at it:
          paths: ["src"]
          # Helpful defaults:
          options:
            docstring_style: numpy
            show_root_heading: true         # show module name as H1
            show_root_toc_entry: false
            show_source: false
            members_order: source           # or "alphabetical"
            group_by_category: true         # groups Classes / Functions / Variables
            inherited_members: true
            filters:
              - "!^_"                       # hide private members
              - "!^__"                      # hide dunders
            heading_level: 2                # start sections at ## under your page H1
            show_signature: true
            merge_init_into_class: true
            show_submodules: false          # keep pages focused unless you want them listed

extra_css:
  - stylesheets/cima-theme.css

extra_javascript:
  - javascripts/cima-brand.js