mkdocs.yml

# mkdocs.yml
site_name: Digitalhub SDK documentation

extra:
  site: https://scc-digitalhub.github.io/sdk-docs
  docs_version: !ENV [DOCS_VERSION, "current"]
  versions: !ENV [VERSIONS]

extra_css:
  - !ENV [USER_STYLESHEETS_PORTAL_SELECTION, "stylesheets/portal_selection.css"]
  - !ENV [USER_STYLESHEETS_COLORS, "stylesheets/colors.css"]

theme:
  name: "material"
  custom_dir: custom/
  palette:
    # Palette toggle for light mode
    - scheme: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.select

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - md_in_html

plugins:
  - search:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_toc_entry: false
            show_labels: false

nav:
  - Index: index.md
  - Quickstart: quickstart.md
  - Installation: install.md
  - Entities:
      - Entities: objects/entities.md
      - Projects:
          - Entity: objects/project/entity.md
          - CRUD: objects/project/crud.md
          - Methods: objects/project/methods.md
          - Config: objects/project/config.md
          - Setup: objects/project/setup.md
      - Functions:
          - Entity: objects/function/entity.md
          - CRUD: objects/function/crud.md
          - Methods: objects/function/methods.md
          - Kinds: objects/function/kinds.md
      - Workflows:
          - Entity: objects/workflow/entity.md
          - CRUD: objects/workflow/crud.md
          - Methods: objects/workflow/methods.md
          - Kinds: objects/workflow/kinds.md
      - Runs:
          - Entity: objects/run/entity.md
          - CRUD: objects/run/crud.md
          - Methods: objects/run/methods.md
          - Kinds: objects/run/kinds.md
      - Artifacts:
          - Entity: objects/artifact/entity.md
          - CRUD: objects/artifact/crud.md
          - Methods: objects/artifact/methods.md
          - Kinds: objects/artifact/kinds.md
      - Dataitems:
          - Entity: objects/dataitem/entity.md
          - CRUD: objects/dataitem/crud.md
          - Methods: objects/dataitem/methods.md
          - Kinds: objects/dataitem/kinds.md
      - Models:
          - Entity: objects/model/entity.md
          - CRUD: objects/model/crud.md
          - Methods: objects/model/methods.md
          - Kinds: objects/model/kinds.md
      - Secrets:
          - Entity: objects/secret/entity.md
          - CRUD: objects/secret/crud.md
          - Methods: objects/secret/methods.md
      - Stores: objects/stores.md
      - Code source: objects/code_source.md
  - Runtimes:
      - Runtimes: runtimes/runtimes.md
      - Python: runtimes/python.md
      - DBT: runtimes/dbt.md
      - Container: runtimes/container.md
      - KFP: runtimes/kfp.md
      - Modelserve: runtimes/modelserve.md
      - Kubernetes resources: runtimes/kubernetes-resources.md