CanvasGroupy/mkdocs.yml at main · FleischerResearchLab/CanvasGroupy · 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
site_name: CanvasGroupy
site_url: https://FleischerResearchLab.github.io/CanvasGroupy
repo_url: https://github.com/FleischerResearchLab/CanvasGroupy
repo_name: FleischerResearchLab/CanvasGroupy

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true
      execute: false
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google
            docstring_options:
              warn_missing_types: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Authentication: getting-started/authentication.md
      - Quick Start: getting-started/quickstart.md
  - Tutorials:
      - Assign Groups Demo: tutorials/assign-groups-demo.ipynb
      - Canvas Groups: tutorials/canvas-groups.md
      - GitHub Repos: tutorials/github-repos.md
      - Grading Workflow: tutorials/grading.md
      - Feedback Templates: tutorials/feedback.md
  - API Reference:
      - AssignGroup: api/assign.md
      - CanvasGroup: api/canvas.md
      - GitHubGroup: api/github.md
      - Grading: api/grading.md