mirror of
https://github.com/NandhaKishorM/laya.git
synced 2026-09-28 07:52:57 +08:00
Maxfield Allison
84c31ce7ad
The navigation puts ARM64 before the Docker quickstart because pages sort by filename. The root .nav.yml now groups them into Guides, Deployment, Fine-tuning and Reference, and hooks/ and reference/ get a reading order. Zensical supports these awesome-nav files without a new dependency. Unlisted pages and folders appear under Guides. The glob uses ignore_no_matches so the strict build also passes when every page is listed.
57 lines
1.9 KiB
TOML
57 lines
1.9 KiB
TOML
# Documentation site, built with Zensical (https://zensical.org). Preview locally:
|
|
# pip install -r requirements-docs.txt && zensical serve
|
|
|
|
[project]
|
|
site_name = "Laya"
|
|
site_description = "Multilingual, non-autoregressive System 1 decision engine"
|
|
site_url = "https://nandhakishorm.github.io/laya/"
|
|
repo_url = "https://github.com/NandhaKishorM/laya"
|
|
repo_name = "NandhaKishorM/laya"
|
|
edit_uri = "edit/main/docs/"
|
|
copyright = "Apache 2.0. Developed by Convai Innovations."
|
|
# The navigation order lives in docs/.nav.yml, read by the awesome-nav plugin below. A page it
|
|
# does not list still appears, so a new page needs no edit here. A folder with an index.md
|
|
# becomes a section that opens on that page.
|
|
|
|
[project.theme]
|
|
# Reuse the README logo to avoid maintaining a second copy.
|
|
logo = "https://raw.githubusercontent.com/NandhaKishorM/laya/main/assets/logo-mark.svg"
|
|
favicon = "https://raw.githubusercontent.com/NandhaKishorM/laya/main/assets/logo-mark.svg"
|
|
features = [
|
|
"content.code.copy",
|
|
"navigation.footer",
|
|
"navigation.indexes",
|
|
]
|
|
|
|
[[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.plugins.awesome-nav]
|
|
|
|
# API reference pages under docs/reference/ are generated from the docstrings in laya/.
|
|
[project.plugins.mkdocstrings.handlers.python]
|
|
paths = ["."]
|
|
|
|
[project.plugins.mkdocstrings.handlers.python.options]
|
|
docstring_style = "google"
|
|
docstring_options = { returns_multiple_items = false }
|
|
docstring_section_style = "list"
|
|
filters = ["!^_"]
|
|
members_order = "source"
|
|
merge_init_into_class = true
|
|
line_length = 70
|
|
separate_signature = true
|
|
show_root_full_path = false
|
|
show_root_heading = true
|
|
show_signature_annotations = true
|
|
show_source = false
|