mkdocs.yml

site_name: HPC Core Facility Cluster Documentation
site_url: http://docs.hpc.ucdavis.edu
repo_url: https://github.com/ucdavis/hpccf-docs
copyright: Copyright © 2023-24 The Regents of the University of California, Davis

nav:
  - General:
    - Account Requests: general/account-requests.md
    - Accessing Clusters: general/access.md
    - Job Scheduling:
      - About: scheduler/index.md
      - Commands: scheduler/commands.md
      - Resources: scheduler/resources.md
      - Job Scripts: scheduler/jobscripts.md
    - Software:
      - About: software/index.md
      - Module System: software/modules.md
      - Conda and Python: software/conda.md
      - R and RStudio: software/rlang.md
      - Development: software/developing.md
    - Data Transfer: data-transfer.md
    - Troubleshooting: general/troubleshooting.md
  - Clusters:
    - Farm:
      - About: farm/index.md
      - Software:
        - Modules: farm/software/modules.md
      - Job Scheduling: farm/scheduling.md
      - Resources: farm/resources.md
      - Storage: farm/storage.md
    - Franklin:
      - About: franklin/index.md
      - Software:
        - Modules: franklin/software/modules.md
        - cryo-EM: franklin/software/cryoem.md
        - alphafold: franklin/software/alphafold.md
      - Job Scheduling: franklin/scheduling.md
      - Resources: franklin/resources.md
      - Storage: franklin/storage.md
  - Admin:
    - admin/index.md
    - Network Architecture: admin/network.md
    - Virtual Machines: admin/vms.md
    - Provisioning: admin/provisioning.md
    - DNS: admin/dns.md
    - Cobbler: admin/cobbler.md
    - Configuration: admin/configuration.md # puppet, etc
    - Software: admin/software.md
    - Netbox: admin/netbox.md
    - Monitoring: admin/monitoring.md
    - Open OnDemand: admin/ondemand.md
#
# Here be dragons! Don't edit these settings unless you Know What You're Doing (tm).
#

markdown_extensions:
  - toc:
      permalink: true
  - def_list
  - attr_list
  - admonition
  - md_in_html
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - 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
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  - macros:
        module_name: macros

extra:
  spack_modulefiles_path: spack-ucdavis/modulefiles/hpccf/franklin/
  social:
    - icon: material/email-edit
      link: "mailto:hpc-help@ucdavis.edu"
      name: Email HPCCF Support
    - icon: fontawesome/brands/slack
      link: https://ucdavis.slack.com/archives/C053NKA88
      name: "#hpc Channel on ucdavis.slack.com"
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/mathjax.js
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

theme:
  name: material
  custom_dir: overrides
  features:
    - content.code.annotate
    #- navigation.tabs
    - navigation.sections
    - navigation.expand
    #- navigation.indexes
    - navigation.instant
    - navigation.top
    #- navigation.footer
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
  logo: assets/HPCCF-logo-dark.png
  favicon: assets/HPCCF-logo.png
  icon:
    repo: fontawesome/brands/github
  palette: 

    # Palette toggle for light mode
    - scheme: ucdavis
      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