mkdocs-template.yml

site_name: XNAT Tools
site_description: Documentation for the xnat-tools model
site_url: http://brown-bnc.github.io/xnat-tools
theme:
  name: material
  palette:
    primary: 'pink'
  icon:
    repo: fontawesome/brands/github-alt
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.expand

repo_name: brown-bnc/xnat-tools
repo_url: https://github.com/brown-bnc/xnat-tools
edit_uri: ''

plugins:
  - search
  - markdownextradata
  - mkdocs-versioning:
      version: ${VERSION}
      version_selection_page: "docs/version_selection.md"
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.append("docs")
          rendering:
            show_root_heading: false
            show_root_toc_entry: false
            heading_level: 3
      watch:
        - xnat_tools

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - codehilite
  - extra

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: 'https://github.com/brown-bnc/xnat-tools' 
  mdvars:
    version: ${VERSION}
nav:
  - Getting Started:
    - Overview: index.md
    - Installation: installation.md
  - Usage:
    - Overview: usage_overview.md
    - xnat2bids: xnat2bids.md
    - xnat-dicom-export: dicom_export.md
    - xnat-heudiconv: run_heudiconv.md
    - bids-postprocess: bids_postprocess.md
  - Development:
    - Setting Up: dev_setup.md
    - Code standards: code_standards.md 
  - Version Selector: "../"