mkdocs.yml

site_name: HyperQueue

site_url: https://it4innovations.github.io/hyperqueue/
repo_url: https://github.com/It4innovations/hyperqueue
edit_uri: blob/main/docs/

site_description: Documentation of HyperQueue.
site_author: Ada Böhm, Jakub Beránek

nav:
  - Overview: README.md
  - Installation: installation.md
  - Getting Started:
      - Quickstart: quickstart.md
      - Cheatsheet: cheatsheet.md
  - Examples:
      - examples/README.md
      - Iterative computation: examples/iterative-computation/README.md
  - Deployment:
      - deployment/index.md
      - Server: deployment/server.md
      - Workers: deployment/worker.md
      - Automatic Allocation: deployment/allocation.md
      - Without Shared Filesystem: deployment/cloud.md
  - Task computation:
      - Jobs and Tasks: jobs/jobs.md
      - Task Arrays: jobs/arrays.md
      - Resources: jobs/resources.md
      - CPU Resources: jobs/cresources.md
      - Handling Failure: jobs/failure.md
      - Output Streaming: jobs/streaming.md
      - Directives: jobs/directives.md
      - Job Definition File: jobs/jobfile.md
      - Open jobs: jobs/openjobs.md
      - Multinode Tasks: jobs/multinode.md
  - CLI:
      - Shortcuts: cli/shortcuts.md
      - Dashboard: cli/dashboard.md
      - Output mode: cli/output-mode.md
  - Python API:
      - Getting started: python/index.md
      - Client: python/client.md
      - Submitting jobs: python/submit.md
      - Dependencies: python/dependencies.md
      - API reference: python/apidoc/
  - Changelog: changelog.md
  - FAQ: faq.md
  - Comparison With Other Tools: other-tools.md

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - header.autohide
    - navigation.instant
    - navigation.top
  #    - navigation.sections
  #    - navigation.tabs
  #    - navigation.indexes
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - toc:
      permalink: "#"
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: .
  - footnotes
  - admonition

plugins:
  - search
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true
      enable_creation_date: true
  - mike:
      canonical_version: stable
  - nedoc:
      path: python/apidoc
  - gen-files:
      scripts:
        - scripts/doc_copy_examples.py

extra:
  analytics:
    provider: google
    property: G-TM8J8R5GJ9
  version:
    provider: mike
    default: stable

extra_css:
  - stylesheets/extra.css