mkdocs.yml

# Project information
site_name: CMS Open Data Guide
site_description: 'CMS Open Data Guide'
site_url: 'https://cms-opendata-guide.web.cern.ch/'

# Repository
repo_name: 'cms-opendata-guide'
repo_url: 'https://github.com/cernopendata/cms-opendata-guide'

# Structure
nav:
    - Home: index.md
    - 'CMS Open Data':
        - 'CERN Open Data Portal': cmsOpenData/cernportal.md
        - 'CMS Open Data': cmsOpenData/cmsopendata.md
        - 'Finding Data': cmsOpenData/findingData.md
        - 'Workshops': cmsOpenData/workshops.md
    - 'Computing Tools':
        - 'UNIX': tools/unix.md
        - 'ROOT': tools/root.md
        - 'C++ and Python': tools/cppandpython.md
        - 'Git': tools/git.md
        - 'Docker': tools/docker.md
        - 'Virtual Machines': tools/virtualmachines.md
    - 'CMSSW':
        - 'Overview': cmssw/cmsswoverview.md
        - 'Data Model': cmssw/cmsswdatamodel.md
        - 'Analyzers': cmssw/cmsswanalyzers.md
        - 'Configuration': cmssw/cmsswconfigure.md
        - 'Conditions Data': cmssw/cmsswconditions.md
    - 'Analysis':
        - 'Data and Simulation':
            - 'Collision Data': analysis/datasim/collisiondata.md
            - 'MC Simulations': analysis/datasim/mcsimulations.md
            - 'Event Generation': analysis/datasim/eventgeneration.md
        - 'Selection':
            - 'Validated Runs': analysis/selection/validatedRuns.md
            - 'Triggers': analysis/selection/triggers.md
            - 'Physics Objects':
                - 'Physics Objects': analysis/selection/objects/objects.md
                - 'Common Tools': analysis/selection/objects/tools.md
                - 'Muons': analysis/selection/objects/muons.md
                - 'Electrons': analysis/selection/objects/electrons.md
                - 'Photons': analysis/selection/objects/photons.md
                - 'Jets': analysis/selection/objects/jets.md
                - 'Missing ET': analysis/selection/objects/met.md
                - 'Taus': analysis/selection/objects/taus.md
            - 'ID Efficiency study':
                - 'Tag and Probe': analysis/selection/idefficiencystudy/tagandprobe.md
                - 'Signal extraction': analysis/selection/idefficiencystudy/signalextraction.md
                - 'Tutorial':
                    - 'Sideband Subtraction':    analysis/selection/idefficiencystudy/tutorial/03-sidebandsubtraction.md
                    - 'Comparison':              analysis/selection/idefficiencystudy/tutorial/04-comparison.md
                    - 'Systematic':              analysis/selection/idefficiencystudy/tutorial/05-systematic.md
                - 'Reference Guide (SB)':
                    - 'The Macro':                 analysis/selection/idefficiencystudy/sidebandreferenceguide/macro.md
                    - 'FitFunction class':         analysis/selection/idefficiencystudy/sidebandreferenceguide/FitFunctions.md
                    - 'SidebandSubtraction class': analysis/selection/idefficiencystudy/sidebandreferenceguide/SidebandSubtraction.md
                    - 'InvariantMass class':       analysis/selection/idefficiencystudy/sidebandreferenceguide/InvariantMass.md
                    - 'MassValues struct':         analysis/selection/idefficiencystudy/sidebandreferenceguide/MassValues.md
                    - 'Type class':                analysis/selection/idefficiencystudy/sidebandreferenceguide/Type.md
                    - 'TagProbe class':            analysis/selection/idefficiencystudy/sidebandreferenceguide/TagProbe.md
                    - 'PtEtaPhi class':            analysis/selection/idefficiencystudy/sidebandreferenceguide/PtEtaPhi.md
                    - 'PassingFailing class':      analysis/selection/idefficiencystudy/sidebandreferenceguide/PassingFailing.md
                - 'Reference Guide (Fit)':
                    - 'Overview':                  analysis/selection/idefficiencystudy/fittingreferenceguide/overview.md
                    - 'Src files':                 analysis/selection/idefficiencystudy/fittingreferenceguide/src_files.md
        - 'Luminosity': analysis/lumi.md
        - 'Background Modelling': analysis/backgrounds.md
        - 'Systematics':
            - 'Luminosity Uncertainties': analysis/systematics/lumiuncertain.md
            - 'MC Uncertainty': analysis/systematics/mcuncertain.md
            - 'Physics Object Uncertainty':
                 - 'Lepton/Photon uncertainties': analysis/systematics/objectsuncertain/leptonuncertain.md
                 - 'Jet/MET uncertainties': analysis/systematics/objectsuncertain/jetmetuncertain.md
                 - 'Tagging uncertainties': analysis/systematics/objectsuncertain/btaguncertain.md
            - 'Pileup Uncertainty': analysis/systematics/pileupuncertain.md
        - 'Statistical Interpretation': analysis/stats.md  
    - FAQ: faq.md
    - About: about.md

# Configuration
theme:
    name: material
    palette:
      scheme: 'default'
      primary: 'indigo'
      accent:
    font:
      text: 'Lato'
    icon:
      repo: 'fontawesome/brands/github'
    logo: 'images/cms-od.png'
    favicon: 'images/cms-od.png'

# Customization
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?version=4.8.0&features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  
# Extensions
markdown_extensions:
    - admonition
    - pymdownx.details
    - pymdownx.superfences
    - codehilite:
        guess_lang: false
    - toc:
        permalink: true
    - pymdownx.superfences
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.arithmatex:
        generic: true
      
# Plugins
plugins:
  - search
  - awesome-pages:
      collapse_single_pages: false