mkdocs.yml

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
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
  - pymdownx.details
  - pymdownx.tasklist:
      clickable_checkbox: true

nav:
  - Home: index.md
  - Download and installation: installation.md
  - Creating a model:
    - creating/index.md
    - YAML as used in Calliope: creating/yaml.md
    - Model configuration: creating/config.md
    - Technologies: creating/techs.md
    - Nodes: creating/nodes.md
    - Inheriting from templates: creating/templates.md
    - Indexed parameters: creating/parameters.md
    - Loading data tables: creating/data_tables.md
    - Scenarios and overrides: creating/scenarios.md
  - Running a model: running.md
  - Analysing a model: analysing.md
  - Troubleshooting: troubleshooting.md
  - Pre-defined math:
    - index: pre_defined_math/index.md
  - Defining your own 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
    - Example additional math gallery:
      - user_defined_math/examples/index.md
  - Examples and tutorials:
    - examples/index.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/piecewise_constraints.py
    - examples/calliope_model_object.py
    - examples/calliope_logging.py
  - Advanced features:
    - advanced/constraints.md
    - advanced/index.md
    - advanced/time.md
    - advanced/scripts.md
    - advanced/mode.md
    - advanced/solver.md
    - advanced/backend_choice.md
    - advanced/backend_interface.md
    - advanced/shadow_prices.md
  - Reference:
    - 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/schema.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