mkdocs.yaml

site_name: Programming Formalisms
repo_url: https://github.com/UPPMAX/programming_formalisms
edit_uri: 'blob/main/docs/'

nav:
  - Home: index.md
  - About the course:
    - Pre-requirements: prereqs.md
    - Introduction: intro.md
  - Schedule: schedule.md
  - Project:
    - Intro: project/README.md
    - Issues: project/issues.md
    - Kanban board: project/kanban_board.md
    - Team roles: project/team_roles.md
    - Create class list: project/create_class_list.md
    - Create structs: project/create_struct.md
    - Dream design: project/dream_design.md
  - Monday:
    - Intro: monday_intro.md
    - Introduction: introductions/intro.md
    - SDLC tools: introductions/sdlc_tools.md
    - Get started with a project: project_start/startup.md
    - Project start with analysis and design: project_start/analysis_design.md
    - Summary of day: monday_summary.md
  - Tuesday:
    - Intro: tuesday_intro.md
    - Software Development Lifecycle: introductions/sdlc.md
    - Issues: project/issues.md
    - Kanban board: project/kanban_board.md
    - Team roles: project/team_roles.md
    - assert: assert/README.md
    - Test-driven development: tdd/README.md
    - Using a formal testing framework: testing/testing_framework.md
    - Summary of day: tuesday_summary.md
  - Wednesday:
    - Intro: wednesday_intro.md
    - Git workflow, branches: git/branches.md
    - Git(-Hub) workflow, branches/merging: git/merge.md
    - Contributing with code review: git/contribute.md
    - Sharing and social coding: social_coding/social_coding.md
    - Pair programming: pair_programming/README.md
    - Using a formal testing framework: testing/testing_framework.md
    - Summary of day: wednesday_summary.md
  - Thursday:
    - Intro: thursday_intro.md
    - Object Oriented development: design_develop/OO_development.md
    - Function design: function_design/README.md
    - Expressive data types: expressive_data_type/README.md
    - Modular programming: modularity/modular.md
    - A 'has-a' relation: has_a_relation/README.md
    - Class design: data_structures/class_design.md
    - Continuous integration: continuous_integration/README.md
    - Summary of day: thursday_summary.md
  - Friday:
    - Intro: friday_intro.md
    - Implement the project as a package: package/README.md
    - Optimisation misconceptions: optimisation/misconceptions.md
    - Big-O: optimisation/big_o.md
    - Runtime speed profiles: optimisation/runtime_speed_profiles.md
    - Deploy: deployment/deploy.md
    - Documentation: deployment/documentation.md
    - Wrap-up: misc/wrap_up.md
    - Summary of day: friday_summary.md
    - Summary of week: summary_week.md
  - Misc:
    - Feedback: misc/feedback.md
    - Evaluations: evaluations/README.md
    - Reflections: reflections/README.md
    - Data: data/README.md
    - Emails: emails/README.md
    - Shared documents: shared_documents/README.md
    - Lesson plans: lesson_plans/README.md
    - Meeting notes: meeting_notes/README.md
    - Definitions: misc/definitions.md
    - Extra material (Earlier Intro day materials): extra.md
    - Project workflows: misc/project_workflows.md
    - Learn UML with mermaid: misc/uml_with_mermaid.md
    - git workflow: misc/git_workflow.md
    - Reading material: reading/README.md
    - FAQ: misc/faq.md
    - Functions to practice TDD: misc/functions.md
    - Retrospective: misc/retrospective.md
    - Wrap-up: misc/wrap_up.md

theme:
  name: material
  greetings: Welcome to the Programming Formalisms course materials
  font:
    text: Lato
    code: JetBrains Mono

  logo: assets/programming_formalism_logo_rhs.png

  features:
    - toc.integrate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.footer
    - navigation.expand
    - search.suggest
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - content.action.view
  custom_dir: mkdocs_uppmax/
    
extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - toc:
      toc_depth: 2
      permalink: true
      permalink_title: Anchor link to this section for reference
  - admonition
  - tables
  - attr_list
  - footnotes
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.keys
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - mkdocs_graphviz

extra_javascript:
  - https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/massilia-graphviz.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js