mkdocs.yml

site_name: LandingAI Python Library Documentation
site_url: https://landing-ai.github.io/
repo_url: https://github.com/landing-ai/landingai-python
edit_uri: edit/main/docs/


theme:
  name: "material"
  custom_dir: docs/_overrides
  features:
    - content.code.copy
    - content.code.annotate
    - content.action.edit

plugins:
  - mkdocstrings
  - search

markdown_extensions:
  # Syntax highlight
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  # Multiline note/warning/etc blocks (https://squidfunk.github.io/mkdocs-material/reference/admonitions)
  - admonition
  - pymdownx.details

nav:
  - Quick start: index.md
  - Examples: examples.md
  - Image Acquisition:
    - Image Acquisition: image-acquisition/image-acquisition.md
    - Image Files: image-acquisition/image-file.md
    - Video Files: image-acquisition/video-file.md
    - Webcam: image-acquisition/webcam.md
    - Network Camera: image-acquisition/network-cameras.md
    - Screenshots: image-acquisition/screenshots.md
  - Image Operations: image-operations.md
  - Running Inferences:
    - Getting Started: inferences/getting-started.md
    - Working with Frames: inferences/frames-inference.md
    - Overlaying Predictions: inferences/overlaying-predictions.md
    - Running Inferences Locally: inferences/docker-deployment.md
    - Snowflake Native App: inferences/snowflake-native-app.md
    - Extracting Text (OCR) [beta]: inferences/ocr.md
  - Data Management: metadata.md
  #- Image operations (soon): image-operations.md
  - APIs:
    - landingai.common: api/common.md
    - landingai.data_management: api/data_management.md
    - landingai.exceptions: api/exceptions.md
    - landingai.image_source_ops: api/image_source_ops.md
    - landingai.notebook_utils: api/notebook_utils.md
    - landingai.pipeline: api/pipeline.md
    - landingai.postprocess: api/postprocess.md
    - landingai.predict: api/predict.md
    - landingai.st_utils: api/st_utils.md
    - landingai.storage: api/storage.md
    - landingai.telemetry: api/telemetry.md
    - landingai.timer: api/timer.md
    - landingai.transform: api/transform.md
    - landingai.utils: api/utils.md
    - landingai.visualize: api/visualize.md
  - Changelog: changelog.md
  - Contributing: contributing.md