pypto-serving/mkdocs.yml at main · hw-native-sys/pypto-serving · 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
# Copyright (c) PyPTO Contributors.
# This program is free software, you can redistribute it and/or modify it under the terms and conditions of
# CANN Open Software License Agreement Version 2.0 (the "License").
# Please refer to the License for details. You may not use this file except in compliance with the License.
# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
# INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
# See LICENSE in the root of the software repository for the full text of the License.
# -----------------------------------------------------------------------------------------------------------
#
# MkDocs configuration for the PyPTO Serving documentation site.
#
# The markdown under `docs/` is the single source of truth and must stay readable
# directly on GitHub; this file only describes how it is rendered. The built site
# is never committed -- CI publishes it to GitHub Pages (see .github/workflows/docs.yml).

INHERIT: .site-theme/docs-theme/base.yml

site_name: PyPTO Serving
site_description: Local inference serving with PyPTO kernels on Ascend NPUs
site_url: https://www.pypto.ai/pypto-serving/
repo_url: https://github.com/hw-native-sys/pypto-serving
repo_name: hw-native-sys/pypto-serving
edit_uri: edit/main/docs/
copyright: Copyright &copy; PyPTO Contributors

docs_dir: docs
site_dir: site

# Build inputs that live under docs/ but are not content.
exclude_docs: |
  _hooks/
  requirements.txt
  theme-revision.txt

# Broken internal links must fail the build, not warn. `mkdocs build --strict`
# promotes every warning to an error; these settings decide what counts as one.
validation:
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn
    anchors: warn
  nav:
    omitted_files: warn
    not_found: warn

theme:
  custom_dir: .site-theme/docs-theme/overrides
  language: en

# Rewrites repo-relative links that escape `docs/` (source files, examples/) into
# GitHub blob URLs at build time. The markdown keeps working relative links for
# readers browsing the repo, and the site gets links that resolve -- without which
# `--strict` fails on every such reference.
hooks:
  - docs/_hooks/repo_links.py

plugins:
  - search

extra:
  pypto_project: pypto-serving
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/hw-native-sys/pypto-serving
      name: PyPTO Serving on GitHub

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - User Guide:
      - Getting Started:
          - Installation: get-started/installation.md
          - Quickstart: get-started/quickstart.md
      - Inference and Serving:
          - Offline Inference: user-guide/offline-inference.md
          - Online Serving: user-guide/online-serving.md
          - Tool Calling: user-guide/tool-calling.md
          - Parallelism and Scaling: user-guide/parallel.md
          - Multi-Node Routing: user-guide/multi-node-routing.md
          - Troubleshooting: user-guide/troubleshooting.md
  - Models:
      - Overview: models/index.md
      - Qwen3-14B: models/qwen3-14b.md
      - DeepSeek V4:
          - Overview: models/deepseek-v4/index.md
          - MTP Deployment: models/deepseek-v4/mtp.md
          - DSpark Deployment: models/deepseek-v4/dspark.md
          - DSpark Tool Constraints: models/deepseek-v4/tool-constraints.md
          - Internals:
              - MTP: models/deepseek-v4/mtp-internals.md
              - DSpark: models/deepseek-v4/dspark-internals.md
  - Reference:
      - HTTP API: api-reference/http.md
      - CLI: cli-reference/pypto-serving.md
      - Router CLI: cli-reference/pypto-serving-router.md
  - Developer Guide:
      - Architecture: developer-guide/architecture.md
      - Profiling: developer-guide/profile.md
      - Model Integration: developer-guide/model-integration.md
      - Weight Staging: developer-guide/weight-staging.md
      - JIT Cache: developer-guide/jit-cache.md