mkdocs.yml

site_name: Staff Scheduling
site_url: https://combirwth.github.io/StaffScheduling/
repo_url: https://github.com/CombiRWTH/StaffScheduling/
repo_name: CombiRWTH/StaffScheduling


nav:
  - Introduction: index.md
  - User View:
      - User View: user-view/index.md
      - Problem Definition: user-view/problem-definition.md
      - List of Conditions: user-view/list-of-conditions.md
      - Getting Started (Light): user-view/getting-started-light-version.md
      - Configuration:
          - Overview of Configurations: user-view/configuration/index.md
          - Assemble Staff: user-view/configuration/staff.md
          - Modify Vacation Days: user-view/configuration/vacation-days.md
          - Modify Forbidden Days / Shifts: user-view/configuration/forbidden-days.md
          - Adapting Weights: user-view/configuration/weights.md
          - Modify Round Permissions: user-view/configuration/rounds-permissions.md
          - Qualification Mapping: user-view/configuration/qualifications.md
          - Minmal Number of Staff: user-view/configuration/min-staff.md
          - Blocking Shifts: user-view/configuration/blocked-shifts.md
          - Preplanning Shifts: user-view/configuration/planned-shifts.md

  - Developer View:
      - Developer View: developer-view/index.md
      - API: developer-view/api.md
      - Web Interface (StaffSchedulingWeb): developer-view/web-interface.md
      - Google's OR Tools and SAT-Solver: developer-view/ortools.md
      - Codebase Overview: developer-view/codebase-overview.md
      - Getting-Started (Dev): developer-view/getting-started-dev.md
      - Conditions:
          - Constraints:
              - Free day after night shift phase: developer-view/conditions/free-day-after-night-shift-phase.md
              - Hierarchy of intermediate shifts: developer-view/conditions/hierarchy-of-intermediate-shifts.md
              - Max one shift per day: developer-view/conditions/max-one-shift-per-day.md
              - Minimum number of staff per shift: developer-view/conditions/minimum-number-of-staff-per-shift.md
              - Minimum rest time: developer-view/conditions/min-rest-time.md
              - Planned shifts: developer-view/conditions/planned-shifts.md
              - Rounds (Visiten): developer-view/conditions/rounds.md
              - Target working time per month: developer-view/conditions/target-working-time-per-month.md
              - Vacation days and free shifts: developer-view/conditions/vacation-days-and-free-shifts.md
          - Objectives:
              - Every second weekend free: developer-view/conditions/every-second-weekend-free.md
              - Free days after night shift phase: developer-view/conditions/free-days-after-night-shift-phase-objective.md
              - Free days near weekend: developer-view/conditions/free-days-near-weekend.md
              - Maximize Wishes: developer-view/conditions/maximize-wishes.md
              - Minimize hidden employees: developer-view/conditions/minimize-hidden-employees.md
              - Minimize number of consecutive night shifts: developer-view/conditions/minimize-number-of-consecutive-night-shifts.md
              - Minimize overtime and undertime: developer-view/conditions/minimize-overtime-and-undertime.md
              - Not too many consecutive working days: developer-view/conditions/not-too-many-consecutive-working-days.md
              - Rotate shifts forwards: developer-view/conditions/rotate-shifts-forwards.md
              - Encourage preferred block length: developer-view/conditions/preferred-block-length.md
      - Database:
            - Connection and Overview: developer-view/database-overview/database-connection.md
            - Tables: developer-view/database-overview/database-tables.md
            - Queries: developer-view/database-overview/database-queries.md
      - How-to-Add Guides:
          - How-to-Add Guides: developer-view/how-to-add/index.md
          - How to add a Constraint: developer-view/how-to-add/how-to-add-constraint.md
          - How to add a Objective: developer-view/how-to-add/how-to-add-objective.md
          - How to add a Variable: developer-view/how-to-add/how-to-add-variable.md
      - VM-Setup: developer-view/vm-setup.md
      - JSON Dataformats: developer-view/json-dataformat.md


theme:
  name: material
  language: en
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs.sticky
    - content.code.copy

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.tabbed
  - attr_list
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      linenums: false
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
  - admonition
  - toc:
      baselevel: 2
      permalink: true
      slugify: !!python/name:pymdownx.slugs.uslugify
  - meta
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets:
      base_path: 'docs'
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
  - include-markdown
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          options:
            # disable by default, as it can not do attributes anyways
            inherited_members: true
            merge_init_into_class: true
            show_source: false