mkdocs.yml

---
site_name: Hera
site_author: Flaviu Vadan, Sambhav Kothari, Elliot Gunton
site_url: https://hera.readthedocs.io/en/latest/
copyright: Copyright © 2023 Flaviu Vadan, Sambhav Kothari, Elliot Gunton

nav:
  - Home: README.md
  - Walk Through:
    - walk-through/quick-start.md
    - walk-through/about-hera.md
    - walk-through/hera-tour.md
    - walk-through/hello-world.md
    - walk-through/parameters.md
    - walk-through/steps.md
    - walk-through/dag.md
    - walk-through/artifacts.md
    - walk-through/loops.md
    - walk-through/conditionals.md
    - walk-through/suspending.md
    - Advanced Features:
      - walk-through/authentication.md
      - walk-through/advanced-workflow-features.md
      - walk-through/advanced-template-features.md
      - walk-through/advanced-hera-features.md
      - walk-through/pydantic-support.md
  - User Guides:
    - Core Concepts: user-guides/core-concepts.md
    - Scripts:
      - Script Basics: user-guides/script-basics.md
      - Script Annotations: user-guides/script-annotations.md
      - Script Runner IO: user-guides/script-runner-io.md
    - Decorators: user-guides/decorators.md
    - Expr Transpiler: user-guides/expr.md
  - Examples:
    - About: examples/workflows-examples.md
    - Idiomatic Hera Examples:
      - Scripts:
        - ... | flat | examples/workflows/scripts/*.md
      - DAGs:
        - ... | flat | examples/workflows/dags/*.md
      - Steps:
        - ... | flat | examples/workflows/steps/*.md
      - Loops:
        - ... | flat | examples/workflows/loops/*.md
      - Artifacts:
        - ... | flat | examples/workflows/artifacts/*.md
      - Experimental Features:
        - ... | flat | examples/workflows/experimental/*.md
      - Miscellaneous Examples:
        - ... | flat | examples/workflows/misc/*.md
    - Use-Cases and Integrations:
      - About: examples/about-use-cases.md
      - ... | flat | examples/workflows/use-cases/*.md
    - Upstream Examples:
      - About: examples/about-upstream.md
      - ... | flat | examples/workflows/upstream/*.md
  - Contributing:
    - Contributing Guide: CONTRIBUTING.md
    - History of Hera: contributing/history.md
  - API Reference:
    - Shared: api/shared.md
    - Workflows:
      - Hera: api/workflows/hera.md
      - Models: api/workflows/models.md
    - Events:
      - Models: api/events/models.md
theme:
  custom_dir: docs/overrides
  font:
    text: Roboto
    code: Roboto Mono
  name: material
  logo: assets/hera-logo.svg
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.copy
    - content.code.select
    - search.suggest
    - search.share
    - search.highlight
    - content.tabs.link
repo_url: https://github.com/argoproj-labs/hera
repo_name: argoproj-labs/hera
edit_uri: blob/main/docs

extra:
  version:
    provider: mike

markdown_extensions:
  - admonition
  - smarty
  - attr_list
  - mkdocs-click
  - pymdownx.smartsymbols
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  #   slugify: !!python/object/apply:pymdownx.slugs.slugify
  #     kwds:
  #       case: lower
plugins:
  - awesome-pages
  - include-markdown
  - autorefs
  - mkdocstrings:
      watch:
        - src
      handlers:
        python:
          options:
            # show_category_heading: true
            show_if_no_docstring: true
            inherited_members: true
            filters: ["!^_.*$"]
            show_bases: false
            separate_signature: true
            docstring_style: google
          rendering:
            show_source: true
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
  - search:
      lang: en