mkdocs.yml

site_name: CANFAR
site_url: https://opencadc.github.io/canfar/
site_author: Shiny Brar
site_description: CANFAR Science Platform
repo_url: https://github.com/opencadc/canfar/
repo_name: opencadc/canfar
edit_uri: blob/main/docs/
copyright: Copyright © 1986-2025 Canadian Astronomy Data Centre
remote_branch: gh-pages

theme:
  logo: static/logo.png
  favicon: static/logo.png
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: canfar
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  language: en
  icon:
    repo: fontawesome/brands/github-alt
    edit: material/pencil-box
    view: material/eye-outline
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tracking
    - navigation.indexes
    - navigation.expand
    - navigation.instant.prefetch
    - toc.follow
    # - toc.integrate
    - navigation.top
    - announce.dismiss
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mkdocstrings:
      handlers:
        python:
          options:
            show_symbol_type_toc: true
            show_signature: true
            separate_signature: true
            line_length: 88
            annotations_path: brief
            docstring_style: google
            docstring_section_style: spacy
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: true
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      fallback_to_build_date: true
  - git-committers:
      enabled: true
      repository: opencadc/canfar
      branch: main
  - termynal

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/opencadc/canfar
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/canfar
    - icon: fontawesome/brands/docker
      link: https://images.canfar.net
    - icon: fontawesome/brands/discord
      link: https://discord.gg/vcCQ8QBvBa
    - icon: fontawesome/solid/paper-plane
      link: mailto:support@canfar.net
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Let us know how we can improve this page.

# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.md_in_html
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
      toc_depth: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      linenums_style: pymdownx.inline
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Platform:
      - Overview: platform/index.md
      - Getting Started: platform/get-started.md
      - Concepts: platform/concepts.md
      - Best Practices: platform/best-practices.md
      - Permissions: platform/permissions.md
      - DOI: platform/doi.md
      - Software Repositories (CVMFS): platform/cvmfs.md
      - Cloud (legacy): platform/cloud.md
      - Sessions:
          - Overview: platform/sessions/index.md
          - Notebooks: platform/sessions/notebook.md
          - CARTA: platform/sessions/carta.md
          - Firefly: platform/sessions/firefly.md
          - Desktop: platform/sessions/desktop.md
          - Batch: platform/sessions/batch.md
          - Contributed: platform/sessions/contributed.md
      - Storage:
          - Overview: platform/storage/index.md
          - Filesystem: platform/storage/filesystem.md
          - Data Transfers: platform/storage/transfers.md
          - VOSpace: platform/storage/vospace.md
      - Containers:
          - Overview: platform/containers/index.md
          - Building Containers: platform/containers/build.md
          - Registry: platform/containers/registry.md
      - Community:
          - Overview: platform/community/index.md
          - CASA: platform/community/CASA_and_more.md
        # - ALMA:
        #   - Overview: platform/community/alma/index.md
        #   - Desktop:
        #     - Archive Download: platform/community/alma/ALMA_Desktop/archive_download.md
        #     - Archive Script Download: platform/community/alma/ALMA_Desktop/archive_script_download.md
        #     - CASA Containers: platform/community/alma/ALMA_Desktop/casa_containers.md
        #     - Start CASA: platform/community/alma/ALMA_Desktop/start_casa.md
        #     - Typical Reduction: platform/community/alma/ALMA_Desktop/typical_reduction.md
        #   - General Tools:
        #     - File Transfers: platform/community/alma/General_tools/File_transfers.md
        #     - Group Management: platform/community/alma/General_tools/Group_management.md
        #     - SSHFS: platform/community/alma/General_tools/Using_sshfs.md
        #     - VOS Tools: platform/community/alma/General_tools/Using_vostools.md
        #     - Web Storage: platform/community/alma/General_tools/Using_webstorage.md
        #   - New Users:
        #     - Overview: platform/community/alma/NewUser/Overview.md
        #     - Login: platform/community/alma/NewUser/Login.md
        #     - Launch CARTA: platform/community/alma/NewUser/LaunchCARTA.md
        #     - Launch Desktop: platform/community/alma/NewUser/LaunchDesktop.md
        #     - Launch Notebook: platform/community/alma/NewUser/LaunchNotebook.md
        #     - Project Space: platform/community/alma/NewUser/ProjectSpace.md
        #   - Notebook:
        #     - Transfer Files: platform/community/alma/Notebook/transfer_file.md
        #   - Tips:
        #     - Direct URL: platform/community/alma/TipsTricks/Direct_url.md
        #     - Increase Font: platform/community/alma/TipsTricks/Increase_font.md
        #     - Clipboard: platform/community/alma/TipsTricks/Using_clipboard.md
      - Support:
          - Help: platform/support/index.md
          - FAQ: platform/support/faq.md
      - Releases:
          - CANFAR Releases: releases/releases.md
          - 2026.1: releases/2026-1.md
          - 2025.2: releases/2025-2.md
          - 2025.1: releases/2025-1.md
  - Client:
      - Home: client/home.md
      - Authentication and Servers: cli/authentication-contexts.md
      - What's New:
          - Updates: client/updates.md
          - Migration Guide: client/migration.md
      - Get Started:
          - Installation & Setup: client/get-started.md
          - 5-Minute Tutorial: client/quick-start.md
      - Examples:
          - Basic: client/examples.md
          - Advanced: client/advanced-examples.md
      - Reference:
          - Python API:
              - AsyncSession: client/async_session.md
              - Session: client/session.md
              - Images: client/images.md
              - Context: client/context.md
              - Overview: client/overview.md
              - HTTPClient: client/client.md
              - Helpers: client/helpers.md
      - CLI:
          - 5-Minute Tutorial: cli/quick-start.md
          - Authentication and Servers: cli/authentication-contexts.md
          - Reference: cli/cli-help.md
      - Demos:
          - SRCnet Workshop: demos/srcnet-workshop.md
      - Bug Reports: client/bug-reports.md
  - Contribute:
      - Code of Conduct: conduct.md
      - OpenSSF Report: https://scorecard.dev/viewer/?uri=github.com/opencadc/canfar
      - License: license.md
      - Dev Guide:
          - Contributing: contributing.md
          - Testing: client/testing.md
          - Agent Guidance:
              - Architecture: agents/architecture.md
              - Domain Docs: agents/domain.md
              - Issue Tracker: agents/issue-tracker.md
              - Triage Statuses: agents/triage-labels.md
      - Operations:
          - Platform Deployments: https://www.opencadc.org/deployments/
      - Security Issues: security.md
      - Changelog: changelog.md
  - About:
      - Home: about/home.md
      - Terms of Reference: about/terms.md
      - Partners: about/partners.md
      - Acknowledgement: about/acknowledgement.md