zensical.toml

[project]
site_name = "Algorithm Nexus Documentation"
site_description = "Documentation website for https://github.com/IBM/algorithm-nexus"
site_author = "The Algorithm Nexus authors"
copyright = """
Copyright © 2026 IBM Research.
"""
nav = [
  { "Getting Started" = [
    { "Overview" = "getting-started/index.md" },
    { "Installation" = "getting-started/installation.md" },
    { "CLI Reference" = "getting-started/cli-reference.md" },
  ] },
  { "Design" = [
    { "Overview" = "design/index.md" },
    { "Nexus Package Structure Guide" = "design/nexus_package.md" },
    { "Dependency Resolution" = "design/dependency-resolution.md" },
    { "Benchmarking Architecture" = [
      "design/benchmarking/index.md",
      { "Logical Benchmarks and Instances" = "design/benchmarking/logical_benchmarks_and_instances.md" },
      { "Benchmark Experiments and Submissions" = "design/benchmarking/benchmark_experiments_and_submissions.md" },
      { "Benchmark Execution and Operations" = "design/benchmarking/benchmark_execution.md" },
    ] },
    { "Project Release" = "design/project_release.md" },
  ] },
  { "Contributing" = [
    { "Overview" = "contributing/index.md" },
    { "Contributing Guidelines" = "contributing/guidelines.md" },
    { "Add New Nexus Package" = "contributing/add_new_nexus_package.md" },
    { "Benchmarks" = [
      "contributing/benchmarks/index.md",
      { "How to Add a Benchmark Problem and Instance" = "contributing/benchmarks/add_benchmark_problem.md" },
      { "How to Add a Benchmark Experiment" = "contributing/benchmarks/add_benchmark_experiment.md" },
      { "How to Bind an Experiment to a Problem" = "contributing/benchmarks/add_benchmark_binding.md" },
      { "How to Add a Benchmark Submission" = "contributing/benchmarks/add_benchmark_submission.md" },
    ] },
    { "Owner Responsibilities" = "contributing/owner_responsibilities.md" },
  ] },
  { "Requirements" = [
    { "Overview" = "requirements/index.md" },
    { "Nexus Package" = "requirements/nexus_package.md" },
    { "Model Testing" = "requirements/models_testing.md" },
    { "Model vLLM" = "requirements/model_vllm.md" },
    { "Packaging and Dependency Management" = "requirements/packaging_and_dependency_reqs.md" },
    { "Benchmarking" = "requirements/benchmark.md" },
  ] },
]
extra_css = [
  "https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100..700;1,100..700&display=swap",
  "https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;1,100;1,200;1,300;1,400;1,500;1,600;1,700&display=swap",
  "stylesheets/extra.css",
]

[project.theme]
name = "material"
language = "en"
logo = "assets/images/logo-ibm-dark.png"
favicon = "assets/images/favicon.ico"
features = [
  "announce.dismiss",
  "content.code.annotate",
  "content.code.copy",
  "content.code.select",
  "content.footnote.tooltips",
  "content.tabs.link",
  "content.tooltips",
  "navigation.footer",
  "navigation.indexes",
  "navigation.instant",
  "navigation.instant.prefetch",
  "navigation.path",
  "navigation.tabs",
  "navigation.tabs.sticky",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  "search.share",
  "search.suggest",
  "toc.integrate",
]

[[project.theme.palette]]
scheme = "default"
primary = "black"
accent = "blue"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "black"
accent = "blue"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/IBM/algorithm-nexus"

[[project.extra.social]]
icon = "fontawesome/solid/globe"
link = "https://www.ibm.com/"

[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]

[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
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.pymdownx.keys]

[project.markdown_extensions.pymdownx.magiclink]

[project.markdown_extensions.pymdownx.mark]

[project.markdown_extensions.pymdownx.snippets]
base_path = [".", "docs"]

[project.markdown_extensions.pymdownx.smartsymbols]

[project.markdown_extensions.pymdownx.superfences]
custom_fences = [{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

[project.markdown_extensions.pymdownx.tilde]