mkdocs.yml

site_name: Developers Guide
docs_dir: docs/
site_url: https://amaurel.github.io/developers_guide/
repo_url: https://github.com/amaurel/developers_guide
repo_name: amaurel/developers_guide
edit_uri: edit/main/docs/
site_author: Tercen Authors
site_description: "Tercen Developers Guide"
use_directory_urls: true

copyright: Copyright © 2024 Tercen

theme:
  name: material
  # custom_dir: .docs/overrides/
  font: false
  favicon: https://tercen.com/_assets/brand/fav.png
  logo: ./images/tercen-logo-sq.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.tabs.link
    - instant
    - navigation.footer
    - navigation.path
    - navigation.sections
#    - navigation.expand
    - navigation.tabs
#    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - tabs
    - content.code.annotate
    - content.code.copy
    - content.action.edit
    - content.action.view
extra_css:
   - stylesheets/style.css
plugins:
  - search
  - git-committers:
      repository: amaurel/developers_guide
      branch: main
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
#  - exclude:
#      glob:
#        - README.md
#        - "*.gotmpl"
#        - "*.gotmpl.md"
#  - awesome-pages
  # - macros:
  #     module_name: .docs/macros/includes/main
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
      #js_files: []
  # - redirects:
  #     redirect_maps:
  #       README.md: Getting-Started/intro.md
  - mike:
      # these fields are all optional; the defaults are as below...
      version_selector: true # set to false to leave out the version selector
      css_dir: css # the directory to put the version selector's CSS
      javascript_dir: js # the directory to put the version selector's JS
      canonical_version:
        null # the version for <link rel="canonical">; `null`
        # uses the version specified via `mike deploy`
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - tables
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tabbed
extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting started:
      - Guidelines: intro_guidelines.md
      - Getting started:
          - Core concepts: getting-started_core-concepts.md
          - Setting up Tercen Studio:    getting-started_setup-tercen-studio.md
      - R Operator development:
          - General workflow: operator-dev_intro.md
          - "Walkthrough example: R operator": operator-dev_create.md
          - Deploying an R operator:   operator-dev_deploy.md
          - Improving an operator:   operator-dev_improve.md
      - Python Operator development:
          - Getting familiar with Tercen Studio: operator-dev_python.md
      - Advanced concepts:
          - Continuous Integration Workflow: operator-dev_ci.md
          - Installing an Operator:    operator-dev_installation.md
          - Common patterns:    operator-dev_patterns.md
      - Templates:
          - Building a template: templates-apps_templates.md
      - Apps:
          - Building an app: templates-apps_apps.md
      - Library:
          - Tercen Library: library.md
      - Best practices:
          - Development guidelines: best-practices_guidelines.md
          - Using tim:    best-practices_using-tim.md
      - Troubleshooting:
          - Common operator issues: troubleshooting_common-issues.md
          - CI and Github Actions:   troubleshooting_ci.md
      - Going forward:
          - Next steps: going-forward_next-steps.md
      - Appendix:
          - Glossary: appendix_glossary.md
          - Organisation setup:   appendix_organisation-setup.md
          - Tercen Studio:   appendix_tercen-studio.md