mkdocs.yml

# 
# -------------------------------------------
# 
# THIS FILE IS AUTOGENERATED, DO NOT EDIT!
# Instead, perform your changes or extensions (to mkdocs_base.yml) in mkdocs_custom.yml
# These files will be merged together into mkdocs.yml (this file)
# 
# -------------------------------------------
# 
copyright: Copyright © Zebbra AG
edit_uri: edit/main/docs
extra:
  social:
  - icon: fontawesome/solid/house
    link: https://zebbra.ch
    name: Zebbra
extra_css:
- assets/extra.css
extra_javascript:
- assets/extra.js
hooks:
- .make_scripts/mkdocs-documentation/hooks/inline_nav_include.py
- .make_scripts/mkdocs-documentation/hooks/fix_symlinks.py
markdown_extensions:
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- admonition
- pymdownx.details
- pymdownx.superfences:
    custom_fences:
    - class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
      name: mermaid
- pymdownx.inlinehilite
- pymdownx.snippets:
    base_path:
    - !relative
    check_paths: true
    restrict_base_path: false
- pymdownx.emoji:
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
    emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.tabbed:
    alternate_style: true
- attr_list
- md_in_html
- pymdownx.tasklist:
    custom_checkbox: true
- abbr
- smarty
- pymdownx.smartsymbols
- pymdownx.magiclink
- pymdownx.betterem
- def_list
nav:
- Start: index.md
- Get started:
  - Get started: getting-started/index.md
  - Run your first test: getting-started/10-pytest.md
  - Plug into Worker SDK: getting-started/15-worker-sdk.md
  - Run locally: getting-started/20-local.md
  - Drive from cURL: getting-started/30-curl.md
  - Wire into CI: getting-started/40-ci.md
- Use from Python:
  - Use from Python: 20-client/index.md
  - Pytest fixtures: 20-client/10-pytest-fixtures.md
  - With Worker SDK: 20-client/15-worker-sdk.md
  - Python client: 20-client/20-python-client.md
  - Client config: 20-client/30-configuration.md
- Run the service:
  - Run the service: 30-server/index.md
  - Operator runbook: 30-server/10-administration.md
  - Server config: 30-server/20-configuration.md
  - Security model: 30-server/30-security.md
  - REST API: 30-server/40-rest-api.md
  - Debugging: 30-server/50-debugging.md
- Set up a host:
  - Set up a host: 40-deployment/index.md
  - Pick a deployment: 40-deployment/05-pick-deployment.md
  - Lab platform:
    - Netlab host: 40-deployment/10-netlab-host-setup.md
    - Vendor setup: 40-deployment/20-vendor-setup.md
  - Networking:
    - Network access: 40-deployment/25-network-enclosure.md
    - Headscale Quick start: 40-deployment/30-headscale-quick-setup.md
    - Headscale Reference: 40-deployment/40-headscale-reference.md
- Concepts:
  - Concepts: 10-concepts/index.md
  - Three-minute tour: 10-concepts/05-tour.md
  - Architecture: 10-concepts/10-architecture.md
  - Session queue: 10-concepts/20-session-queue.md
  - Lab lifecycle: 10-concepts/30-lab-lifecycle.md
  - Topology format: 10-concepts/40-topology-format.md
- Contributing:
  - Contributing: 50-contributing/index.md
  - Your first PR: 50-contributing/05-first-pr.md
  - Dev setup: 50-contributing/10-dev-setup.md
  - Invariants: 50-contributing/20-invariants.md
  - Async discipline: 50-contributing/30-internals-async.md
  - LabManager: 50-contributing/40-internals-lab-manager.md
  - atexit & lifespan: 50-contributing/50-internals-atexit.md
  - Test stubbing: 50-contributing/60-internals-test-stubbing.md
  - Anti-patterns: 50-contributing/70-anti-patterns.md
- Appendix:
  - Appendix: 99-appendix/index.md
  - Glossary: 99-appendix/glossary.md
  - Cookbook: 99-appendix/cookbook.md
  - Neops ecosystem: 99-appendix/neops-ecosystem.md
plugins:
- search
- include_dir_to_nav
- monorepo
- exclude:
    glob:
    - '*.tmp'
    - '*.pdf'
    - '*.gz'
    - node_modules
    - '**/node_modules/*'
    - .venv
    - '**/.venv/*'
    - includes/*
    regex:
    - .*\.(tmp|bin|tar)$
repo_url: https://github.com/zebbra/remote-lab
site_name: Neops Remote Lab
theme:
  custom_dir: docs/override
  favicon: assets/favicon.png
  features:
  - content.code.annotate
  - content.code.copy
  - content.tabs.link
  - header.autohide
  - announce.dismiss
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.path
  - navigation.top
  - navigation.tracking
  - navigation.instant
  - search.share
  - search.suggest
  - search.highlight
  - content.action.edit
  - toc.follow
  logo: assets/logo.svg
  name: material
  palette:
  - media: (prefers-color-scheme)
    toggle:
      icon: material/link
      name: Switch to light mode
  - accent: indigo
    media: '(prefers-color-scheme: light)'
    primary: blue grey
    scheme: default
    toggle:
      icon: material/toggle-switch
      name: Switch to dark mode
  - accent: deep orange
    media: '(prefers-color-scheme: dark)'
    primary: black
    scheme: slate
    toggle:
      icon: material/toggle-switch-off
      name: Switch to system preference