FilesExpand file tree

 main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

133 lines (133 loc) · 3.45 KB

 main

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

133 lines (133 loc) · 3.45 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

site_name: py-moodle

site_description: A modern Pythonic CLI and library to manage Moodle via web sessions

site_author: Ernesto Serrano

site_url: https://erseco.github.io/python-moodle/

repo_name: erseco/python-moodle

repo_url: https://github.com/erseco/python-moodle

edit_uri: edit/main/docs/

theme:

name: material

language: en

favicon: images/favicon.png

palette:

- scheme: default

primary: blue

accent: blue

toggle:

icon: material/brightness-7

name: Switch to dark mode

- scheme: slate

primary: blue

accent: blue

toggle:

icon: material/brightness-4

name: Switch to light mode

features:

- content.code.copy

- content.code.annotate

- navigation.sections

- navigation.tabs

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- toc.follow

icon:

repo: fontawesome/brands/github

markdown_extensions:

- admonition

- attr_list

- md_in_html

- toc:

permalink: true

- pymdownx.details

- pymdownx.emoji:

emoji_generator: !!python/name:material.extensions.emoji.to_svg ''

emoji_index: !!python/name:material.extensions.emoji.twemoji ''

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets:

base_path:

- docs

- .

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format ''

- pymdownx.tabbed:

alternate_style: true

- pymdownx.tasklist:

custom_checkbox: true

plugins:

- search

- mkdocstrings:

handlers:

python:

paths:

- src

options:

docstring_style: google

docstring_section_style: table

filters:

- '!^_'

heading_level: 1

inherited_members: true

merge_init_into_class: true

separate_signature: true

show_root_heading: true

show_signature_annotations: true

show_source: false

signature_crossrefs: true

summary: true

members_order: source

group_by_category: true

show_category_heading: true

show_if_no_docstring: true

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/erseco/python-moodle

name: GitHub Repository

- icon: fontawesome/brands/python

link: https://pypi.org/project/python-moodle/

name: PyPI Package

nav:

- Home: index.md

- Getting Started:

- getting-started/index.md

- Installation: getting-started/installation.md

- Configuration: getting-started/configuration.md

- Quick Start: getting-started/quickstart.md

- CLI Reference: cli.md

- API Reference:

- Core:

- Session: api/session.md

- Settings: api/settings.md

- Auth: api/auth.md

- Course Management:

- Course: api/course.md

- Category: api/category.md

- Section: api/section.md

- Content Modules:

- Module: api/module.md

- Label: api/label.md

- Page: api/page.md

- Resource: api/resource.md

- Folder: api/folder.md

- URL: api/url.md

- SCORM: api/scorm.md

- Assignment: api/assign.md

- File Management:

- Upload: api/upload.md

- Draftfile: api/draftfile.md

- User Management:

- User: api/user.md

- Examples: examples.md

- Recipes: recipes.md

- Development: development.md

- Troubleshooting: troubleshooting.md

- Improvement Roadmap: roadmap-plan.md