zensical.zh.toml

[project]
site_name = "SAHI 文档"
site_url = "https://obss.github.io/sahi/zh/"
repo_url = "https://github.com/obss/sahi"
repo_name = "obss/sahi"
edit_uri = "https://github.com/obss/sahi/tree/main/docs/zh"
docs_dir = "docs/zh"
site_dir = "site/zh"
extra_css = ["stylesheets/extra.css"]

# 结构完整镜像英文 zensical.toml 的 nav,仅翻译标题
nav = [
  {"首页" = "index.md"},
  {"快速开始" = "quick-start.md"},
  {"使用指南" = [
    {"切片推理原理" = "guides/sliced-inference.md"},
    {"模型集成" = "guides/models.md"},
    {"预测工具" = "predict.md"},
    {"COCO 数据集操作" = "coco.md"},
    {"切片工具" = "slicing.md"},
    {"后处理后端" = "postprocess/backends.md"},
    {"FiftyOne 可视化" = "fiftyone.md"},
    {"CLI 命令" = "cli.md"},
  ]},
  {"Notebooks" = "notebooks.md"},
  {"代码参考" = [
    {"高层 API" = [
      "predict.md",
      "slicing.md",
    ]},
    {"核心" = [
      "annotation.md",
      "prediction.md",
      "auto_model.md",
    ]},
    {"模型" = [
      "models/base.md",
      "models/ultralytics.md",
      "models/yolov5.md",
      "models/yoloe.md",
      "models/yolo-world.md",
      "models/mmdet.md",
      "models/detectron2.md",
      "models/huggingface.md",
      "models/huggingface_segmentation.md",
      "models/torchvision.md",
      "models/rtdetr.md",
      "models/roboflow.md",
    ]},
    {"后处理" = [
      "postprocess/backends.md",
      "postprocess/combine.md",
      "postprocess/utils.md",
    ]},
    {"工具" = [
      {"COCO 工具" = "utils/coco.md"},
      {"计算机视觉工具" = "utils/cv.md"},
      {"文件工具" = "utils/file.md"},
    ]},
  ]},
  {"API 参考索引" = "api.md"},
  {"贡献指南" = "contributing.md"},
  {"许可证" = "license.md"},
  {"更新日志" = "changelog.md"},
]

[project.theme]
language = "zh"
variant = "material"
logo = "images/sahi-logo.svg"
favicon = "images/sahi-logo.svg"
features = [
  "navigation.tracking",
  "content.code.copy",
  "content.action.edit",
  "content.tooltips",
  "content.code.annotate",
  "navigation.tabs",
  "navigation.tabs.sticky",
  "navigation.top",
  "navigation.indexes",
]
font.text = "Inter"
font.code = "IBM Plex Mono"
icon.edit = "material/pencil"

[[project.theme.palette]]
scheme = "default"
primary = "custom"
toggle.icon = "material/brightness-7"
toggle.name = "切换到深色模式"

[[project.theme.palette]]
scheme = "slate"
primary = "custom"
toggle.icon = "material/brightness-4"
toggle.name = "切换到浅色模式"

# --- Alternate languages ---

[[project.extra.alternate]]
name = "English"
link = "/sahi/"
lang = "en"

[[project.extra.alternate]]
name = "中文"
link = "/sahi/zh/"
lang = "zh"

[[project.extra.alternate]]
name = "Türkçe"
link = "/sahi/tr/"
lang = "tr"

# --- Social links ---

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/obss/sahi"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/sahi"

# --- Plugins ---

[project.plugins.search]

[project.plugins.mkdocstrings]
default_handler = "python"

[project.plugins.mkdocstrings.handlers.python.options]
parameter_headings = true
allow_inspection = true
show_bases = true
group_by_category = true
docstring_style = "google"
show_symbol_type_heading = true
show_root_heading = true
show_symbol_type_toc = true
show_category_heading = true

# --- Python Markdown extensions ---

[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]

[project.markdown_extensions.toc]
permalink = true

# --- PyMdown extensions ---

[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]

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

[project.markdown_extensions.pymdownx.snippets]
check_paths = true

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.arithmatex]
generic = true

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"