comphy-python101/mkdocs.yml at main · comphy-lab/comphy-python101 · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
site_name: CoMPhy Python 101
site_description: Learn to reason with Python for scientific computing.
site_author: Vatsal Sanjay and CoMPhy Lab contributors
site_url: https://comphy-lab.org/comphy-python101/
repo_url: https://github.com/comphy-lab/comphy-python101
repo_name: comphy-lab/comphy-python101
edit_uri: edit/main/docs/
copyright: >-
  Code BSD-3-Clause · Lessons and original teaching material CC BY 4.0

theme:
  name: material
  custom_dir: overrides
  language: en
  logo: assets/comphy-python101-mark.svg
  favicon: assets/comphy-python101-mark.svg
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: comphy-light
      toggle:
        icon: material/weather-night
        name: Use dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: comphy-dark
      toggle:
        icon: material/weather-sunny
        name: Use light mode
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow

nav:
  - Home: index.md
  - Start here:
      - Course overview: start/overview.md
      - Set up once: start/setup.md
      - Python preflight: start/python-preflight.md
      - How to learn here: start/how-to-learn.md
  - Core:
      - "01 · Think like a program": core/01-thinking.md
      - "02 · Functions are claims": core/02-functions.md
      - "03 · Arrays are the language": core/03-arrays.md
      - "04 · Control and algorithms": core/04-control.md
      - "05 · Debugging and tests": core/05-debugging.md
      - "06 · Data has a schema": core/06-data.md
      - "07 · Plots are arguments": core/07-plotting.md
      - "08 · Numerical verification": core/08-numerics.md
      - "09 · Analysis becomes a tool": core/09-tools.md
      - "10 · Reproducible collaboration": core/10-reproducibility.md
  - CoMPhy labs:
      - "11 · Read a Basilisk log": comphy/11-basilisk-log.md
      - "12 · Build a regime map": comphy/12-regime-map.md
  - Practice:
      - Practice map: practice/index.md
      - "Lab 12 · Log to evidence": practice/12-log-to-evidence.md
      - "Lab 13 · Evidence to capsule": practice/13-evidence-to-capsule.md
  - Capstone:
      - "13 · Reproduction capsule": comphy/13-capstone.md
  - Reference:
      - Syntax map: reference/syntax-map.md
      - Command line and Git: reference/command-line-git.md
      - Scientific Python taste: reference/taste.md
  - About:
      - For instructors: about/instructors.md
      - Contributing: about/contributing.md
      - Licences: about/licences.md

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - javascripts/site.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - .
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

validation:
  absolute_links: warn
  omitted_files: warn
  unrecognized_links: warn