calliope/mkdocs.yml at main · THD-Spatial-AI/calliope · 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
site_name: Calliope
# FIXME: `en/latest` should be changed to `en/stable` once there is a stable mkdocs based release
site_url: https://calliope.readthedocs.io/en/latest/
copyright: Copyright &copy; since 2013 <a href="https://github.com/calliope-project/calliope/blob/main/AUTHORS">Calliope contributors</a> (Apache 2.0 licensed)
repo_url: https://github.com/calliope-project/calliope
hooks:
  - docs/hooks/changelog_highlight.py
  - docs/hooks/generate_math_examples.py
  - docs/hooks/generate_readable_schema.py
  - docs/hooks/generate_math_docs.py
  - docs/hooks/generate_plots.py
  - docs/hooks/add_notebooks.py
  - docs/hooks/clean_search.py
extra:
  min_python_version: "3.10"
  max_python_version: "3.12"
  calliope_version: !!python/name:calliope._version.__version__
theme:
  font:
    text: Lato
    code: Source Code Pro
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
    - search.share
  logo: img/logo-bw.png
  favicon: img/favicon.ico
extra_css:
  - css/extra.css
plugins:
  - search
  - autorefs
  - macros:
      module_name: docs/hooks/macros
  - mkdocs-jupyter:
      include: ["examples/**/*.py", "examples/*.py"]
      ignore: ["examples/.*/*.py"]
      allow_errors: false
      kernel_name: calliope_docs_build
      include_source: True
      execute: true
      include_requirejs: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_bases: true
            filters:
              - "!^_"
            heading_level: 1
            show_root_heading: true
            merge_init_into_class: true
            show_if_no_docstring: true
            signature_crossrefs: true
            show_root_toc_entry: false
            show_signature_annotations: false
            inherited_members: true
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://docs.xarray.dev/en/stable/objects.inv
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - mkdocs-click
  - def_list
  - tables
  - toc:
      permalink: "¶"
      toc_depth: 3
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      preserve_tabs: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      dedent_subsections: true
  - pymdownx.details
  - pymdownx.tasklist:
      clickable_checkbox: true

nav:
  - Home: index.md
  - Download and installation: installation.md
  - Getting started:
    - Basic concepts: getting_started/concepts.md
    - Creating a model: getting_started/creating.md
    - Running a model: getting_started/running.md
    - Analysing a model: getting_started/analysing.md
  - Troubleshooting: troubleshooting.md
  - Building blocks:
    - Model configuration: basic/config.md
    - Modes: basic/modes.md
    - Technologies: basic/techs.md
    - Nodes: basic/nodes.md
    - Data tables: basic/data_tables.md
    - Data definitions: basic/data_definitions.md
    - Scenarios and overrides: basic/scenarios.md
    - Running in the command line: basic/running-cli.md
    - Running in Python: basic/running-python.md
    - Postprocessing: basic/postprocessing.md
  - Math:
    - Built-in base math: math/base/index.md
    - Other built-in math:
      - math/built_in/index.md
    - User-defined math:
      - user_defined_math/index.md
      - user_defined_math/components.md
      - user_defined_math/syntax.md
      - user_defined_math/helper_functions.md
      - user_defined_math/customise.md
  - User-defined math examples:
    - user_defined_math/examples/index.md
  - Advanced features:
    - advanced/constraints.md
    - advanced/time.md
    - advanced/scripts.md
    - advanced/solver.md
    - advanced/backend_choice.md
    - advanced/backend_interface.md
    - advanced/shadow_prices.md
  - Example models and tutorials:
    - Overview: examples/overview.md
    - National scale example model:
      - examples/national_scale/index.md
      - examples/national_scale/notebook.py
    - Urban scale example model:
      - examples/urban_scale/index.md
      - examples/urban_scale/notebook.py
    - MILP example model:
      - examples/milp/index.md
      - examples/milp/notebook.py
    - examples/loading_tabular_data.py
    - examples/modes.py
    - examples/piecewise_constraints.py
    - examples/calliope_model_object.py
    - examples/calliope_logging.py
  - Reference:
    - YAML as used in Calliope: reference/yaml.md
    - Command line interface: reference/cli.md
    - Python API:
      - reference/api/model.md
      - reference/api/backend_model.md
      - reference/api/helper_functions.md
      - reference/api/example_models.md
      - reference/api/attrdict.md
      - reference/api/exceptions.md
      - reference/api/logging.md
    - reference/config_schema.md
    - reference/data_table_schema.md
    - reference/model_schema.md
    - reference/math_schema.md
  - migrating.md
  - Contributing: contributing.md
  - Version history: version_history.md