ABM/mkdocs.yml at main · SANDAG/ABM · 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
site_name: "SANDAG ABM3"
site_url: https://sandag.github.io/abm
repo_url: https://github.com/SANDAG/ABM

use_directory_urls: false

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - navigation.expand
    - content.code.annotate
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: light blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - autorefs
  - mike
  - mkdocs-jupyter:
      include_source: True
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
          rendering:
            show_root_heading: false
            show_source: true
            heading_level: 3
     # custom_templates: templates
  - search
  - table-reader
  - mermaid2

nav:
  - Home: index.md
  - Model Design:
    - Overall Design: design/design.md
    - Initialization: design/init/initialization.md
    - Demand:
        - design/demand/index.md
        - design/demand/resident.md
        - design/demand/crossborder.md
        - design/demand/airport.md
        - design/demand/visitor.md
        - design/demand/cvm.md
        - design/demand/external.md
        - design/demand/av-routing.md
        - design/demand/taxi-tnc-routing.md
    - Supply:
        - design/supply/index.md
        - design/supply/bike-logsums.md
        - design/supply/walk-skims.md
        - design/supply/network-import-tned.md
        - design/supply/highway-skims-assign.md
        - design/supply/transit-skims-assign.md
    - Report: design/report/report.md
  - Getting Started:
    - Installation: installation.md
    - Running the Model: running.md
    - Performance and Runtime: performance.md
    - Storage Usage: storage-usage.md
  - Model Inputs and Outputs:
    - Inputs:
        - Overview: inputs.md
        - Networks: networks.md
    - Outputs: outputs.md
    - Reports: reports.md
  - Applying ABM3:
    - Model Application: application/applying.md
    - Population Synthesis: application/population-synthesis.md
    - Land Use Data Preparation: application/landuse-prep.md
    - Settings Manager: application/settings-manager.md
    - Scenario Manager: application/scenario-manager.md
    - EV Rebates: application/ev-rebates.md
    - Flexible Fleets: application/flexible-fleets.md
    - Micromobility: application/micromobility.md
    - Network Coding: application/network-coding.md
  - Calibration and Validation:
    - Overview: calib_valid/calib_overview.md
    - Calibration: calib_valid/calibration.md
    - Convergence: calib_valid/convergence.md
    - Validation: calib_valid/validation.md
    - Sensitivity Testing: calib_valid/sensitivity.md
  - Reference:
    - Release Notes: release-notes.md
    - FAQs: faq.md
    - Technical Reports: technical-reports.md

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - stylesheets/extra.css
  - https://use.fontawesome.com/releases/v5.13.0/css/all.css

markdown_extensions:
  - admonition
  - codehilite:
      linenums: true
  - meta
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.smartsymbols
  - smarty
  - tables
  - toc:
      # insert a blank space before the character
      permalink: " ¶"
      toc_depth: 3
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.arithmatex:
      generic: true

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