CoursePreparation/mkdocs.yml at master · PythonCharmers/CoursePreparation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
site_name: Python Charmers Course Preparation
site_url: https://prep.pythoncharmers.com
site_description: >-
  What to expect from your Python Charmers training course, how to set up
  Python, and an introductory tutorial for those new to programming.
copyright: >-
  Adapted from "A Byte of Python" by Swaroop C H, and released like the
  original under CC BY-SA 4.0.

docs_dir: docs
site_dir: build/site

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
  palette:
    # Respect the reader's system setting, with a manual toggle.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details

plugins:
  - search

# Mirrors the old SUMMARY.md ordering.
nav:
  - Introduction: index.md
  - What To Expect: what_to_expect.md
  - Installation: installation.md
  - Background Study: preparation.md
  - A Byte of Python:
      - About These Notes: byte_of_python.md
      - About Python: about_python.md
      - First Steps: first_steps.md
      - Basics: basics.md
      - Operators and Expressions: op_exp.md
      - Control Flow: control_flow.md
      - Functions: functions.md
      - Modules: modules.md
      - Data Structures: data_structures.md
      - Problem Solving: problem_solving.md
      - Object Oriented Programming: oop.md
      - Input and Output: io.md
      - Exceptions: exceptions.md
      - Standard Library: stdlib.md
      - More: more.md
  - Resources: what_next.md
  - Licence: LICENSE.md

# Sample data used by the examples, not pages in their own right.
exclude_docs: |
  poem.txt
  programs/