mkdocs.yml

site_name: ProcessScheduler
site_description: A Python framework for project and team management. Automatic and optimized resource scheduling.
strict: true
site_url: https://processscheduler.github.io/
site_author: Thomas Paviot

# Repository
repo_name: tpaviot/processscheduler
repo_url: https://github.com/tpaviot/processscheduler

# Copyright
copyright: |
  &copy; 2024 <a href="https://github.com/tpaviot" target="_blank" rel="noopener">Thomas Paviot</a>

# Configuration
theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  language: en
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono

watch:
- processscheduler

nav:
- Introduction:
  - Features: features.md
  - What's inside: inside.md
  - Download/Install: download_install.md
  - Run: run.md
- Concepts:
  - Workflow: workflow.md
  - Scheduling Problem: scheduling_problem.md
  - Represent:
    - Tasks: task.md
    - Resources: resource.md
    - Resource Assignmnent: resource_assignment.md
    - Buffers: buffer.md
    - Functions: function.md
    - Indicators: indicator.md
  - Constraint:
    - Task constraints: task_constraints.md
    - Resource Constraints: resource_constraints.md
    - Indicator Constraints: indicator_constraints.md
    - Customized Constraints: customized_constraints.md
    - First Order Logics: first_order_logic_constraints.md
  - Solve:
    - Solver: solving.md
    - Optimize objectives: objectives.md
  - Render:
    - Gantt Chart: gantt_chart.md
    - Data exchange: data_exchange.md
- Use cases:
  - FlowShop: use-case-flow-shop.md
  - Formula One: use-case-formula-one-change-tires.md
  - Team Management: use-case-software-development.md
  - Scheduling - Theory, Algorithms, and Systems: pinedo.md
- Blog:
  - blog/index.md

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/tpaviot/ProcessScheduler
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/processscheduler/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/thomaspaviot/

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

# Plugins
plugins:
  - blog
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
#  - minify:
#      minify_html: true

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true
      title: Page contents
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.arithmatex:
      generic: true
  - footnotes