-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
112 lines (106 loc) · 2.92 KB
/
mkdocs.yml
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
site_name: QuestionPy
site_url: https://questionpy.org/
repo_url: https://github.com/questionpy-org/
repo_name: questionpy-org
nav:
- About:
- about/index.md
- about/project.md
- about/roadmap.md
- about/license.md
- Getting Started:
- getting_started/index.md
- getting_started/installation.md
- getting_started/create_qtype.md
- getting_started/faq.md
- Documentation:
- documentation/index.md
- documentation/package_structure.md
- documentation/configuration.md
- documentation/formmodel.md
- documentation/identifier.md
- documentation/qtype.md
- documentation/resources.md
- documentation/building.md
- LMS:
- Moodle:
- documentation/LMS/Moodle/index.md
- Reference: '!include ./questionpy-sdk/mkdocs.yml'
- Contribute:
- contribute/index.md
- contribute/translation.md
- contribute/documentation.md
- contribute/discussion.md
- contribute/development.md
plugins:
- devbuild: # need to run before `monorepo`
enabled: !ENV MKDOCS_DEV
- redirects:
redirect_maps:
'index.md': about/index.md
- search
- monorepo
- mkdocstrings:
default_handler: python
enable_inventory: true
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
paths:
- questionpy-sdk
- questionpy-server
options:
docstring_style: google
group_by_category: true
heading_level: 1
show_category_heading: true
show_root_heading: true
preload_modules:
- questionpy_common
theme:
name: material
language: en
features:
- navigation.indexes
- navigation.instant
- navigation.tabs
- content.code.copy
icon:
repo: fontawesome/brands/github
logo: img/logo.svg
favicon: img/favicon.ico
palette:
# light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
- abbr
- attr_list
- admonition
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: true
extra_css:
- stylesheets/extra.css
# TODO: In the future Versioning could become relevant (see https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/)