vdms/mkdocs.yml at develop · IntelLabs/vdms · 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
138
139
140
141
142
143
144
145
146
147
# PROJECT INFORMATION
site_name: VDMS Documentation
site_url: https://intellabs.github.io/vdms/
repo_url: http://github.com/IntelLabs/vdms
copyright: Copyright &copy; 2025 Intel Corporation
edit_uri: http://github.com/IntelLabs/vdms/blob/develop/docs/

# DOCUMENTATION LAYOUT
nav:
  - Home: "index.md"
  - Getting Started:
      - Install: "Install.md"
      - Docker: "Docker.md"
      - VDMS Mutual TLS Support: "guides/VDMS-mTLS-Support.md"
  - API (v2.0.0++):
      - Description: "API-Description.md"
      - ConfigFile: "ConfigFile.md"
      - Keywords: "Keywords.md"
      - Returned Status: "Returned-Status.md"
      - Schema Definition: "Schema.md"
      - Commands:
        - Basic Building Blocks: # "commands/basic_building_blocks_index.md"
            - Constraints: "blocks/Block-constraints.md"
            - Link: "blocks/Block-link.md"
            - Operations: "blocks/Block-operations.md"
            - Properties: "blocks/Block-properties.md"
            - Rectangle: "blocks/Block-rectangle.md"
            - Results: "blocks/Block-results.md"
        - Insert:   #"commands/insert_index.md"
            - AddBlob: "commands/AddBlob.md"
            - AddBoundingBox: "commands/AddBoundingBox.md"
            - AddConnection: "commands/AddConnection.md"
            - AddDescriptor: "commands/AddDescriptor.md"
            - AddDescriptorSet: "commands/AddDescriptorSet.md"
            - AddEntity: "commands/AddEntity.md"
            - AddImage: "commands/AddImage.md"
            - AddVideo: "commands/AddVideo.md"
            - NeoAdd: "commands/NeoAdd.md"
            - NeoAddDescriptor: "commands/NeoAddDescriptor.md"
            - NeoAddDescriptorSet: "commands/NeoAddDescriptorSet.md"
        - Query: #"commands/query_index.md"
            - ClassifyDescriptor: "commands/ClassifyDescriptor.md"
            - FindBlob: "commands/FindBlob.md"
            - FindBoundingBox: "commands/FindBoundingBox.md"
            - FindConnection: "commands/FindConnection.md"
            - FindDescriptor: "commands/FindDescriptor.md"
            - FindDescriptorSet: "commands/FindDescriptorSet.md"
            - FindEntity: "commands/FindEntity.md"
            - FindFrames: "commands/FindFrames.md"
            - FindImage: "commands/FindImage.md"
            - FindVideo: "commands/FindVideo.md"
            - NeoFind: "commands/NeoFind.md"
            - NeoFindDescriptor: "commands/NeoFindDescriptor.md"
            - NeoFindDescriptorSet: "commands/NeoFindDescriptorSet.md"
        - Update: # "commands/update_index.md"
            - UpdateBlob: "commands/UpdateBlob.md"
            - UpdateBoundingBox: "commands/UpdateBoundingBox.md"
            - UpdateConnection: "commands/UpdateConnection.md"
            - UpdateEntity: "commands/UpdateEntity.md"
            - UpdateImage: "commands/UpdateImage.md"
            - UpdateVideo: "commands/UpdateVideo.md"
  - Tutorials & Guides:
      - Tutorials:
        - Simple Tutorial: "tutorials/Simple-Tutorial.md"
        - Image Tutorial: "tutorials/Image-Tutorial.md"
        - Descriptor Tutorial: "tutorials/Descriptor-Tutorial.md"
      - How-to Guides:
        - Backends & Query Handlers:
          - Neo4j based Scale Out: "guides/backends-and-handlers/Neo4J-Based-Scale-Out-VDMS.md"
          - Query Handler Development: "guides/backends-and-handlers/Query-Handler-Development.md"
        - Connectors & Orchestrations:
          - Kafka Connectors for VDMS: "guides/connectors-and-orchestrations/Run-Kafka-VDMS-Example.md"
          - Kubernetes Orchestration in VDMS: "guides/connectors-and-orchestrations/Kubernetes-Orchestration.md"
        - CSV Plugin for C++ Client: "guides/CSV-Plugin-for-CPP-Client.md"
        - Deletion, Backup, & Restore:
          - Auto-Deletion of Expired Data: "guides/deletion-backup-and-restore/Auto-Deletion-of-Expired-Data.md"
          - Backup and Restoring Options: "guides/deletion-backup-and-restore/VDMS-Backup-and-Restoring-Options.md"
          - Deletion Capabilities: "guides/deletion-backup-and-restore/Deletion-Capabilities.md"
        - Descriptors:
          - Descriptors Memory Usage: "guides/descriptors/Descriptor-Memory-Usage.md"
          - FLINNG Library and Performance: "guides/descriptors/FLINNG-Library-and-Performance.md"
        - Remote & User Defined Operations:
          - Remote Operations: "guides/remote-and-udf-operations/Remote-Operations.md"
          - User Defined Operations: "guides/remote-and-udf-operations/User-Defined-Operations.md"
          - Dynamically Add Metadata: "guides/remote-and-udf-operations/Dynamic-Metadata.md"
        - Remote Storage: "guides/Remote-Storage-in-VDMS.md"
        - Timing Capability: "guides/Timing-Capability.md"
  - Interactive Guide:
      - DeepWiki: "https://deepwiki.com/IntelLabs/vdms"
  - Contribute:
      - Developer Guide: "contribute/Developer-Guide.md"
      - Test Suite:
        - VDMS Test Suite Overview: "contribute/VDMS-Test-Suite.md"
        - VDMS Test Script: "contribute/VDMS-Test-Script.md"
not_in_nav: |
  blocks/*
  # commands/Add*.md
  commands/Classify*.md
  # commands/Find*.md
  # commands/Neo*.md
  commands/NeoClassifyDescriptor.md
  # commands/Update*.md
  guides/*

# BUILD DIRECTORIES
theme:
  name: readthedocs
  # name: material
  palette:
    - primary: light blue

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference
  # logo: images/IL_logo.png
  icon:
    logo: material/database
    repo: fontawesome/brands/github
  features:
    - navigation.tabs

# FORMATTING OPTIONS
markdown_extensions:
  - attr_list
  - toc:
      permalink: true
  - pymdownx.snippets:
      url_download: true
  - pymdownx.superfences:
plugins:
  - search