mkdocs.yaml

site_name: Documentation
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_url: https://github.com/open-energy-transition/technology-data
repo_name: open-energy-transition/technology-data
edit_uri: edit/master/docs/

# Navigation
nav:
- Home:
  - Home: index.md
  - Release Notes: home/release-notes.md
  - FAQ: home/faq.md
  - License: home/license.md

- Tutorial: tutorial/index.md

- User Guide:
  - Data Package: user_guide/datapackage.md
  - Models: user_guide/models.md
  - Parameter: user_guide/parameter.md
  - Source: user_guide/source.md
  - Source Collection: user_guide/source_collection.md
  - Technology: user_guide/technology.md
  - Technology Collection: user_guide/technology_collection.md
  - Equation System: user_guide/equations.md
  - DEA Energy Storage Parser: user_guide/dea_energy_storage_parser.md
  - Manual Input USA Parser: user_guide/manual_input_usa_parser.md
  - Data Accessor: user_guide/data_accessor.md
  - Use Cases: user_guide/design.md

- Examples:
  - Danish Energy Agency Parser (version 10): examples/dea_storage_v10.md
  - Manual Input USA Parser (version 0.13.4): examples/manual_input_usa_v0134.md

- API Reference:
  - Data Package: api/datapackage.md
  - Equations: api/equations.md
  - Parameter: api/parameter.md
  - Source: api/source.md
  - Source Collection: api/source_collection.md
  - Technology: api/technology.md
  - Technology Collection: api/technology_collection.md
  - Data Accessor: api/data_accessor.md
  - Dea Energy Storage Parser: api/dea_energy_storage_parser.md
  - Manual Input USA Parser: api/manual_input_usa_parser.md
  - Utils:
    - Commons:
      - Common functionalities: api/commons/commons.md
      - File extension enumeration: api/commons/fileextensionenum.md
      - Date format enumeration: api/commons/dateformatenum.md
    - Units:
      - Custom undefined unit error: api/units/customundefineduniterror.md
      - Special unit registry: api/units/specialunitregistry.md


- Contributing:
  - Instructions: contributing/instructions.md
  - Code of Conduct: contributing/CODE_OF_CONDUCT.md
  - Contributors: contributing/contributors.md
  - API Improvement Proposals: contributing/api_improvement_proposals.md

# Theme settings
theme:
  name: material
  logo: assets/logo/technology_data_logo.png
  favicon: assets/logo/technology_data_logo.png
  custom_dir: docs/assets/overrides
  font:
    text: Overpass
  features:
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.sections
  - navigation.tracking   # Anchor tracking
  - navigation.indexes   # Section indexes
  - navigation.path
  - navigation.top   # Back to top button
    # - navigation.foot
  - header.autohide
  - content.action.edit
  - content.action.view
  - toc.follow
  - search
  - search.suggest
  - search.highlight
  - search.share
  - announce.dismiss

  palette:
  - media: "(prefers-color-scheme: light)"
    primary: custom
    scheme: default
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    primary: custom
    scheme: slate
    toggle:
      icon: material/weather-night
      name: Switch to light mode

extra_css:
- assets/stylesheets/extra.css

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

markdown_extensions:
  # Callouts/ Admonitions
- admonition
- pymdownx.details
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
    generic: true
  # Footnotes
- footnotes
  # Tabbed content
- pymdownx.tabbed:
    alternate_style: true   # Abbreviations
- pymdownx.snippets:
    auto_append:
    - includes/abbreviations.md
- abbr
- attr_list
- md_in_html
    # Emojis
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
                                                       # Toctree with permalinks

- toc:
    title: On this page
    permalink: true
    toc_depth: 3
    # Grids
- md_in_html
- pymdownx.caret
- pymdownx.tilde

plugins:
- search
- tags
- autolinks
- table-reader
- mkdocs-video
- git-revision-date-localized:
    type: timeago
    timezone: Europe/Berlin
    enable_creation_date: true
    enable_parallel_processing: false
- argref:
    autolinks:
    - reference_prefix: ":octicons-git-pull-request-16:"
      target_url: https://github.com/open-energy-transition/technology-data/pull/<num>
- social:
    cards_layout_options:
      font_family: Overpass
      background_color: "#292F36"

  # Docstring generation
- mkdocstrings:
    enabled: true
    default_handler: python
    handlers:
      python:
        options:
          docstring_style: numpy
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: list
          filters:
          - "!^_[^_]"
          - "!logger"
          - "!iteration"
          heading_level: 1
          merge_init_into_class: true
          parameter_headings: false
          separate_signature: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_source: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true
          show_if_no_docstring: true
          show_inheritance_diagram: true
          show_root_toc_entry: false

hooks:
- docs/assets/overrides/hooks/shortcodes.py
- docs/assets/overrides/hooks/release_notes.py

copyright: >-
  &copy technologydata contributors