mkdocs.yml

site_name: EcoLogits
site_url: https://ecologits.ai/
repo_name: genai-impact/ecologits
repo_url: https://github.com/genai-impact/ecologits

nav:
  - 'Get Started':
    - 'Welcome to EcoLogits': index.md
    - 'Why use EcoLogits': why.md
    - 'Supported providers': tutorial/providers.md
    - 'FAQ': faq.md
    - 'Contributing': contributing.md
  - 'Tutorial':
      - 'Introduction': tutorial/index.md
      - 'Environmental Impacts': tutorial/impacts.md
      - 'Warnings and Errors': tutorial/warnings_and_errors.md
      - 'Supported providers': tutorial/providers.md
      - 'Providers':
          - 'Anthropic': tutorial/providers/anthropic.md
          - 'Cohere': tutorial/providers/cohere.md
          - 'Google Gemini': tutorial/providers/google.md
          - 'Hugging Face Hub': tutorial/providers/huggingface_hub.md
          - 'LiteLLM': tutorial/providers/litellm.md
          - 'Mistral AI': tutorial/providers/mistralai.md
          - 'OpenAI': tutorial/providers/openai.md
  - 'Methodology':
      - 'Introduction': methodology/index.md
      - 'LLM Inference': methodology/llm_inference.md
  - 'API Reference': reference/
  - 'Online Calculator': 'https://huggingface.co/spaces/genai-impact/ecologits-calculator'

theme:
  name: material
  custom_dir: docs/theme
  logo: assets/leaf.svg
  favicon: assets/leaf.svg
  font:
    text: Roboto
  palette:
    - scheme: ecologits
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - announce.dismiss

extra:
  version:
    alias: true
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/genai-impact
      name: GenAI Impact GitHub organization
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/genai-impact/
      name: GenAI Impact LinkedIn

extra_css:
  - css/extra.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

extra_javascript:
  - js/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

watch:
  - docs
  - ecologits

plugins:
  - search
  - social:
      cards_layout_options:
        background_color: "#0b3b36"
  - autorefs
  - gen-files:
      scripts:
        - docs/scripts/gen_references.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          paths: [ ecologits ]
          options:
            members_order: source
            docstring_style: google
            docstring_options:
              ignore_init_summary: yes
            merge_init_into_class: yes
            inherited_members: true
  - mike:
      alias_type: symlink
      canonical_version: latest


markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - tables
  - admonition
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true
  - 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.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true