mkdocs.yml

# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
site_name: PyTriton
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
      primary: black
  features:
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.sections
extra_css:
  - assets/styles.css
repo_url: https://github.com/triton-inference-server/pytriton
repo_name: Git Repository
plugins:
  - autorefs
  - htmlproofer
  - mike
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            show_root_heading: true
            heading_level: 2
            line_length: 120
            docstring_section_style: list
            merge_init_into_class: true
            inherited_members: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
  - search
watch:
  - pytriton
  - docs
  - mkdocs.yml
  - LICENSE
  - README.md
  - CHANGELOG.md
  - CONTRIBUTING.md
view_uri_template: blob/{ref}/{path}  # used by scripts/rewrite_links_to_repo.py hook
hooks:
  - scripts/rewrite_links_to_repo.py
extra:
  version:
    provider: mike
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
nav:
  - Learn:
    - Overview: README.md
    - Quick Start: quick_start.md
    - Installation: installation.md
    - High-Level Design: high_level_design.md
    - Deploying Models:
      - Triton Initialization: initialization.md
      - Binding Model to Triton: binding_models.md
      - Binding Configuration: binding_configuration.md
      - Triton Remote Mode: remote_triton.md
    - Inference Callable:
      - Overview: inference_callables/README.md
      - Decorators: inference_callables/decorators.md
      - Custom parameters/headers: inference_callables/custom_params.md
    - Model Clients: clients.md
  - Guides:
    - Building binary package: guides/building.md
    - Deploying in Clusters: guides/deploying_in_clusters.md
    - Distributed Tracing: guides/distributed_tracing.md
    - Chunking and batching: guides/chunking.md
    - Downloaded input data: guides/downloaded_input_data.md
    - Basic Troubleshooting: guides/basic_troubleshooting.md
  - Tutorials: examples.md
  - Reference:
    - Triton: reference/triton.md
    - Triton Config: reference/triton_config.md
    - Model Config: reference/model_config.md
    - Decorators: reference/decorators.md
    - Model Clients: reference/clients.md
  - Resources:
    - Changelog: CHANGELOG.md
    - Known Issues: known_issues.md
    - Contributing: CONTRIBUTING.md
    - License: LICENSE.md