_zensical.toml

#
# Documentation is generated with Zensical.
#
# scripts/docs.sh reads this file (`_zensical.toml`), inserts the auto-generated API Reference
# section, and saves it to `zensical.toml`, which is the actual config file used by Zensical.
# 
# Doc build:
#     uv run bash scripts/docs.sh build
#
# Doc preview:
#     uv run bash scripts/docs.sh serve
#
[project]
site_name = "OpenG2G: GPU-to-Grid Simulation under LLM Workloads"
site_description = "A modular library for simulating datacenter-grid interactions under LLM workloads."
site_url = "https://gpu2grid.io/openg2g"
repo_name = "gpu2grid/openg2g"
repo_url = "https://github.com/gpu2grid/openg2g"
extra_css = ["assets/extra.css"]
extra = { og_image = "https://gpu2grid.io/openg2g/assets/og.jpeg" }
extra_javascript = [
  "javascripts/mathjax.js",
  "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js",
]
nav = [
  { "Home" = "index.md" },
  { "Getting Started" = [
    { "Installation" = "getting-started/installation.md" },
    { "Quickstart" = "getting-started/quickstart.md" },
  ]},
  { "Guide" = [
    { "Concepts and Background" = "guide/concepts.md" },
    { "Architecture" = "guide/architecture.md" },
    { "Data Pipeline" = "guide/data-pipeline.md" },
    { "Building Simulators" = "guide/building-simulators.md" },
  ]},
  { "API Reference" = "auto-generated by scripts/docs.sh and scripts/gen_api_docs.py" },
]

[project.theme]
custom_dir = "docs/overrides"
features = [
  "content.code.copy",
  "navigation.sections",
  "navigation.expand",
  "toc.follow",
]
favicon = "assets/transmission-tower.svg"
logo = "assets/transmission-tower.svg"

[project.theme.icon]
repo = "fontawesome/brands/github"

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
smart_enable = "all"
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]

[project.plugins.mkdocstrings.handlers.python]
inventories = [
  "https://ml.energy/data/objects.inv",
]

[project.plugins.mkdocstrings.handlers.python.options]
show_source = true
show_root_heading = true
show_root_full_path = true
members_order = "source"
relative_crossrefs = true
filters = ["!^_"]