mkdocs.yml

site_name: Triage Documentation
theme:
  name: 'material'
  palette:
    primary: 'blue grey'
    accent: 'deep orange'
  font:
    text: 'Ubuntu'
    code: 'Ubuntu Mono'
  icon:
    logo: ./material/book
  favicon: 'assets/images/favicon.ico'

site_url: http://dssg.github.io/triage

docs_dir: sources
repo_name: 'dssg/triage'
repo_url: http://github.com/dssg/triage
edit_uri: edit/master/docs/sources
site_description: 'Documentation for Triage.'

extra:
  social:
    - icon: fontawesome/brands/github
      link: 'https://github.com/dssg/triage'
    - icon: fontawesome/brands/twitter
      link: 'https://twitter.com/datascifellows'
    - icon: fontawesome/brands/linkedin
      link: 'https://linkedin.com/company/center-for-data-science-and-public-policy-university-of-chicago'


markdown_extensions:
  - toc:
      permalink: "#"
      baselevel: 1
      separator: "-"
  - admonition
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - meta
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.b64
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols:
      arrows: false
  - pymdownx.highlight
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.superfences

extra_javascript:
  - "js/mermaid.min.js"
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

extra_css:
  - "triage_docs.css"

plugins: 
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_source: false
      watch:
        - src/triage


nav:
  - Home: index.md
  - Online Tutorial (Google Colab): https://colab.research.google.com/github/dssg/triage/blob/master/example/colab/colab_triage.ipynb
  - Get started with your own project:
    - Quickstart guide: quickstart.md
    - Suggested workflow: triage_project_workflow.md
  - Dirty Duck Tutorial:
    - Welcome!: dirtyduck/index.md
    - Dirty duckling: dirtyduck/dirty_duckling.md
    - Case studies:
      - Problem description: dirtyduck/problem_description.md
      - Early Warning System: dirtyduck/eis.md
      - Resource prioritization: dirtyduck/inspections.md
    - Triage:
      - A deeper look into triage: dirtyduck/triage_intro.md
    - Are you curious about the setup?:
      - Infrastructure: dirtyduck/infrastructure.md
      - Data preparation: dirtyduck/data_preparation.md
      - Quick setup: dirtyduck/for_the_impatient.md
  - Triage documentation:
    - Experiment:
      - Experiment Configuration: experiments/experiment-config.md
      - Testing Feature Configuration: experiments/feature-testing.md
      - Running an Experiment: experiments/running.md
      - Upgrading an Experiment:
        - v7 -> v8: experiments/upgrade-to-v8.md
        - v6 -> v7: experiments/upgrade-to-v7.md
        - v5 -> v6: experiments/upgrade-to-v6.md
        - v3/v4 -> v5: experiments/upgrade-to-v5.md
      - Temporal Validation Deep Dive: experiments/temporal-validation.md
      - Cohort and Label Deep Dive: experiments/cohort-labels.md
      - Prediction Ranking: experiments/prediction-ranking.md
      - Feature Generation Recipe Book: experiments/features.md
      - Experiment Algorithm: experiments/algorithm.md
      - Experiment Architecture: experiments/architecture.md
    - Model selection: 
      - Intro to Audition: audition/audition_intro.md
      - Model Selection Concepts: audition/model_selection.md
      - API Reference: api/audition/index.md
    - Postmodeling: 
      - Using Postmodeling: postmodeling/index.md
      - Postmodeling & Crosstabs Configuration: postmodeling/postmodeling-config.md
    - Model governance: dirtyduck/ml_governance.md
    - Predictlist: predictlist/index.md
    - Scaling up: dirtyduck/aws_batch.md
    - Database Provisioner: db.md
    - API Reference:
      - Audition: 
        - Auditioner: api/audition/auditioner.md
        - Audition Configuration: api/audition/audition-config.md
        - Selection Rules: api/audition/selection_rules.md
        - Database Dependencies: api/audition/database-dependencies.md