ecologits/mkdocs.yml at main · mlco2/ecologits · 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: EcoLogits
site_url: https://ecologits.ai/
repo_name: mlco2/ecologits
repo_url: https://github.com/mlco2/ecologits

nav:
  - 'Home': index.md
  - 'Get Started':
    - 'Welcome to EcoLogits': get_started.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
      - 'OpenTelemetry': tutorial/opentelemetry.md
      - 'Providers':
          - 'Anthropic': tutorial/providers/anthropic.md
          - 'Cohere': tutorial/providers/cohere.md
          - 'Google Gemini': tutorial/providers/google_genai.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
      - 'Proprietary models': methodology/proprietary_models.md
      - 'LLM Inference': methodology/llm_inference.md
  - 'API Reference': reference/
  - 'Blog':
      - blog/index.md
  - 'EcoLogits 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/mlco2
      name: GitHub
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ecologits/
      name: LinkedIn
    - icon: fontawesome/brands/discord
      link: https://discord.gg/CAecQ2zM4n
      name: Discord

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

extra_javascript:
  - js/katex.js
  - js/installer.js
  - js/clipboard_copy.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
  - blog

markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - tables
  - admonition
  - def_list
  - footnotes
  - 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:
      auto_append:
        - docs/_abbreviations
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true