flextensor/mkdocs.yml at main · ai-dynamo/flextensor · 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

site_name: FlexTensor Documentation
site_description: Tensor offloading and management library for PyTorch
site_url: https://ai-dynamo.github.io/flextensor/
site_dir: build/docs

repo_url: https://github.com/ai-dynamo/flextensor
repo_name: flextensor

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    primary: black
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.expand
    - navigation.sections
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest

nav:
  - Get Started:
      - Overview: index.md
      - Quick Start: quick-start.md
      - Installation: installation.md
  - Understand:
      - Configuration: explanation/configuration.md
      - Pattern Matching: explanation/pattern-matching.md
      - Internal Phases: explanation/phases.md
      - Tensor Discovery: explanation/tensor-discovery.md
  - Guides:
      - Troubleshooting: how-to/troubleshooting.md
      - Configure for Common Scenarios: how-to/configure-for-common-scenarios.md
      - Exclude Patterns: how-to/exclude-patterns.md
  - Reference:
      - Overview: api/index.md
      - Glossary: api/glossary.md
      - Simplified API: api/simplified.md
      - OffloadManager: api/offload-manager.md
      - Configuration: api/configuration.md
      - Strategies: api/strategies.md
      - Advanced: api/advanced.md
  - Dashboard: https://github.com/ai-dynamo/flextensor

plugins:
  - search
  - mkdocstrings:
      enable_inventory: true
      default_handler: python
      handlers:
        python:
          paths: ["src"]
          import:
            - https://docs.python.org/3/objects.inv
            - https://pytorch.org/docs/stable/objects.inv
          options:
            docstring_style: google
            docstring_options:
              trim_doctest_flags: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 2
            members_order: source
            show_source: false
            show_bases: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            merge_init_into_class: true
            inherited_members: true
            docstring_section_style: spacy
            filters:
              - "!^_"
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ""
      canonical_version: latest
      version_selector: true
      css_dir: css
      javascript_dir: js

watch:
  - docs
  - mkdocs.yml
  - README.md
  - src/flextensor

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - abbr
  - pymdownx.snippets:
      auto_append:
        - docs/includes/abbreviations.md
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ai-dynamo/flextensor

extra_css:
  - assets/stylesheets/extra.css