mkdocs.yml

site_name: "EasyBuild tutorial"
site_url: https://easybuilders.github.io/easybuild-tutorial
extra:
  analytics:
    provider: google
    property: UA-168742780-1
theme:
  name: material
  logo: img/easybuild_logo.png
  features:
      - instant
repo_name: EasyBuild @ GitHub
repo_url: https://github.com/easybuilders
edit_uri: easybuild-tutorial/edit/master/docs
nav:
  - Home: index.md
  - "ISC'21 (25 June 2021)":
      - (overview): 2021-isc21/index.md
      - Practical info: 2021-isc21/practical_info.md
      - Introduction: 2021-isc21/introduction.md
      - Terminology: 2021-isc21/terminology.md
      - Installation: 2021-isc21/installation.md
      - Configuration: 2021-isc21/configuration.md
      - Basic usage: 2021-isc21/basic_usage.md
      - Installing software: 2021-isc21/installing_software.md
      - Troubleshooting: 2021-isc21/troubleshooting.md
      - Module naming schemes: 2021-isc21/module_naming_schemes.md
      - Support for additional software: 2021-isc21/adding_support_additional_software.md
      - EasyBuild at JSC: 2021-isc21/jsc.md
      - EasyBuild at Compute Canada: 2021-isc21/computecanada.md
      - The EasyBuild community: 2021-isc21/community.md
      - Contributing to EasyBuild: 2021-isc21/contributing.md
  - Archive:
      - "ISC'20 (June '20)":
          - Start page: 2020-06-isc20/index.md
          - Practical information: 2020-06-isc20/practical_information.md
          - Introduction: 2020-06-isc20/introduction.md
          - Installation: 2020-06-isc20/installation.md
          - Configuration: 2020-06-isc20/configuration.md
          - Basic usage: 2020-06-isc20/basic_usage.md
          - Troubleshooting: 2020-06-isc20/troubleshooting.md
          - Hierarchical module naming schemes: 2020-06-isc20/hmns.md
          - Adding support for additional software: 2020-06-isc20/adding_support_software.md
          - EasyBuild at Jülich Supercomputing Centre: 2020-06-isc20/jsc.md
          - EasyBuild at Compute Canada: 2020-06-isc20/computecanada.md
          - The EasyBuild community: 2020-06-isc20/community.md
          - Contributing to EasyBuild: 2020-06-isc20/contributing.md
          - Comparison with other tools: 2020-06-isc20/comparison_other_tools.md
          - Getting help: 2020-06-isc20/getting_help.md
      - "LUST (spring '21)":
          - (overview): 2021-lust/index.md
          - Introduction to EasyBuild:
              - (overview): 2021-lust/part1_intro.md
              - What is EasyBuild?: 2021-lust/what_is_easybuild.md
              - Terminology: 2021-lust/terminology.md
              - Installation: 2021-lust/installation.md
              - Configuration: 2021-lust/configuration.md
              - Basic usage: 2021-lust/basic_usage.md
          - Using EasyBuild:
              - (overview): 2021-lust/part2_using.md
              - Troubleshooting: 2021-lust/troubleshooting.md
              - Creating easyconfig files: 2021-lust/creating_easyconfig_files.md
              - Implementing easyblocks: 2021-lust/implementing_easyblocks.md
          - Advanced topics:
              - (overview): 2021-lust/part3_advanced.md
              - Using EasyBuild as a library: 2021-lust/easybuild_library.md
              - Using hooks to customise EasyBuild: 2021-lust/hooks.md
              - Submitting installations as Slurm jobs: 2021-lust/slurm_jobs.md
              - Module naming schemes (incl. hierarchical): 2021-lust/module_naming_schemes.md
              - GitHub integration to facilitate contributing to EasyBuild: 2021-lust/github_integration.md
          - EasyBuild on Cray systems:
              - (overview): 2021-lust/part4_cray.md
              - Introduction to the Cray PE: 2021-lust/cray/introduction.md
              - Using external modules: 2021-lust/cray/external_modules.md
              - Custom Cray toolchains: 2021-lust/cray/custom_toolchains.md
              - EasyBuild at CSCS: 2021-lust/cray/easybuild_at_cscs.md
plugins:
  # show revision date at bottom of each page
  - git-revision-date-localized
  # necessary for search to work
  - search
  # redirects to avoid broken URLs in original version of the tutorial (June 2020)
  - redirects:
      redirect_maps:
          practical_information.md: 2020-06-isc20/practical_information.md
          introduction.md: 2020-06-isc20/introduction.md
          installation.md: 2020-06-isc20/installation.md
          configuration.md: 2020-06-isc20/configuration.md
          basic_usage.md: 2020-06-isc20/basic_usage.md
          troubleshooting.md: 2020-06-isc20/troubleshooting.md
          hmns.md: 2020-06-isc20/hmns.md
          adding_support_software.md: 2020-06-isc20/adding_support_software.md
          jsc.md: 2020-06-isc20/jsc.md
          computecanada.md: 2020-06-isc20/computecanada.md
          community.md: 2020-06-isc20/community.md
          contributing.md: 2020-06-isc20/contributing.md
          comparison_other_tools.md: 2020-06-isc20/comparison_other_tools.md
          getting_help.md: 2020-06-isc20/getting_help.md

markdown_extensions:
  # notes, warnings, hints, ...
  - admonition
  # code blocks with syntax highlighting, graphs
  - pymdownx.superfences
  # clickable details
  - pymdownx.details
  # tabbed contents
  - pymdownx.tabbed
  - toc:
      permalink: true
extra:
  # add links in bottom right
  social:
      #- type: github
      #icon: octicons/logo-github
      #link: https://github.com/easybuilders
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/easy_build
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/c/easybuilders
    - icon: fontawesome/solid/book
      link: https://easybuild.readthedocs.io