mkdocs.yml

site_name: NOS Docs
site_url: https://docs.nos.run
site_author: Sudeep Pillai
site_dir: site
site_description: >-
  NOS -- A fast, and flexible AI inference server.
repo_url: https://github.com/autonomi-ai/nos
repo_name: autonomi-ai/nos
docs_dir: .
use_directory_urls: false
copyright: >
  Copyright &copy; 2022 - 2024 <a href="https://autonomi.ai" target="_blank">Autonomi AI, Inc.</a> All rights reserved.

nav:
  - 🏠 Home: README.md
  - 🔥 Quickstart: docs/quickstart.md
  - 🧠 Models: docs/models/supported-models.md
  - ⚡️ Concepts:
    - What is NOS?: docs/concepts/architecture-overview.md
    - Model specification: docs/concepts/model-spec.md
    - HW-aware execution: docs/concepts/model-manager.md
    - Runtime environments: docs/concepts/runtime-environments.md
  - 📚 Usage Guide:
    - Starting the server: docs/guides/starting-the-server.md
    - Running inference: docs/guides/running-inference.md
    - Serving custom models: docs/guides/serving-custom-models.md
  - 🤖 Demos:
    - Build a Discord image-generation bot: docs/demos/discord-bot.md
    - Build a video search engine: docs/demos/video-search.md
    - Profiling models with NOS: docs/demos/profiling-models-with-nos.md
  - 👩‍💻 API Reference:
    - CLI:
      - <kbd>nos serve</kbd>: docs/cli/serve.md
      - <kbd>nos system</kbd>: docs/cli/system.md
    - nos.common:
      - nos.common.exceptions: docs/api/common/exceptions.md
      - nos.common.metaclass: docs/api/common/metaclass.md
      - nos.common.shm: docs/api/common/shm.md
      - nos.common.spec: docs/api/common/spec.md
      - nos.common.system: docs/api/common/system.md
      - nos.common.types: docs/api/common/types.md
      - nos.common.tasks: docs/api/common/tasks.md
    - nos.client: docs/api/client.md
    - nos.server: docs/api/server.md
    - nos.hub: docs/api/hub.md
    - nos.managers: docs/api/managers.md
    - nos.executors: docs/api/executors.md
  - 🔌 Integrations:
    - SkyPilot: docs/integrations/skypilot.md
  - ✍️ Blog: docs/blog
  - ❓ Support / FAQ: docs/support.md

plugins:
- include-markdown
- autorefs
- blog:
    enabled: !ENV [ENABLE_BLOG, true]
    blog_dir: docs/blog
    blog_toc: true
    post_date_format: medium
    post_url_format: "{slug}"


- mkdocstrings:
    enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
    default_handler: python
    handlers:
      python:
        paths: [.]
        options:
          annotations_path: brief
          members_order: source
          line_length: 80
          docstring_options:
            ignore_init_summary: false
          merge_init_into_class: false
          docstring_style: google
          docstring_section_style: list
          show_docstring_description: true
          show_source: true
          show_root_heading: yes
          show_bases: false
          show_signature_annotations: true
          separate_signature: true
          signature_crossrefs: true

- tags
- same-dir
- search
- social
- table-reader
- exclude:
    glob:
      - nos/cli/README.md
      - build/*
      - conda/*
      - docker/*
      - makefiles/*
      - requirements/*
      - tests/*
      - nos/experimental/*
    regex:
      - '.*\.(tmp|bin|tar)$'

markdown_extensions:
- attr_list
- md_in_html
- admonition
- mkdocs-typer
- pymdownx.betterem
- pymdownx.details
- pymdownx.superfences
- markdown.extensions.footnotes
- markdown.extensions.attr_list
- markdown.extensions.def_list
- markdown.extensions.tables
- markdown.extensions.abbr
- markdown.extensions.md_in_html
- pymdownx.details
- pymdownx.extra
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.tasklist:
    custom_checkbox: true
- toc:
    permalink: True
    toc_depth: 4

theme:
  favicon: docs/assets/favicon.png
  logo: docs/assets/favicon.png
  name: material
  custom_dir: docs/overrides
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.tracking
    - toc.follow

extra:
  analytics:
    provider: google
    property: G-J38LQZWLM3
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:support@autonomi.ai
    - icon: fontawesome/brands/github
      link: https://github.com/autonomi-ai/nos
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/74939899
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/autonomi_ai
    - icon: fontawesome/brands/discord
      link: https://discord.gg/QAGgvTuvgg