FilesExpand file tree

 master

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

183 lines (183 loc) · 5.74 KB

 master

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

183 lines (183 loc) · 5.74 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

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

site_name: Audex Documentation

site_description: Audex is an intelligent medical transcription system designed specifically for clinical scenarios.

site_author: BoChenSHEN

site_url: https://6ixgodd.github.io/audex

repo_name: 6ixGODD/audex

repo_url: https://github.com/6ixGODD/audex

edit_uri: edit/main/docs/

copyright: Copyright © 2025 BoChenSHEN

theme:

name: material

language: en

logo: assets/logo.svg

favicon: assets/logo.svg

palette:

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: indigo

accent: indigo

font:

text: Roboto

code: Roboto Mono

features:

- announce.dismiss

- content.action.edit

- content.action.view

- content.code.annotate

- content.code.copy

- content.tooltips

- navigation.expand

- navigation.footer

- navigation.indexes

- navigation.instant

- navigation.instant.prefetch

- navigation.instant.progress

- navigation.path

- navigation.sections

- navigation.tabs

- navigation.tabs.sticky

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- toc.follow

extra:

version:

provider: mike

social:

- icon: fontawesome/brands/github

link: https://github.com/6ixGODD

- icon: fontawesome/brands/python

link: https://pypi.org/project/audex

analytics:

provider: google

property: !ENV GOOGLE_ANALYTICS_KEY

extra_css:

- assets/stylesheets/extra.css

extra_javascript:

- assets/javascripts/extra.js

markdown_extensions:

- abbr

- admonition

- attr_list

- def_list

- footnotes

- md_in_html

- tables

- toc:

permalink: true

title: On this page

- pymdownx.arithmatex:

generic: true

- pymdownx.betterem:

smart_enable: all

- pymdownx.caret

- pymdownx.details

- pymdownx.emoji:

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

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

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.keys

- pymdownx.mark

- pymdownx.smartsymbols

- pymdownx.snippets

- 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

- pymdownx.tilde

plugins:

- search:

lang:

- en

- zh

separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'

- mkdocstrings:

handlers:

python:

options:

docstring_style: google

docstring_section_style: table

show_root_heading: true

show_root_full_path: false

show_source: true

show_category_heading: true

show_symbol_type_heading: true

show_symbol_type_toc: true

members_order: source

group_by_category: true

show_if_no_docstring: false

show_signature: true

show_signature_annotations: true

separate_signature: true

signature_crossrefs: true

merge_init_into_class: true

inherited_members: false

- minify:

minify_html: true

minify_js: true

minify_css: true

htmlmin_opts:

remove_comments: true

cache_safe: true

nav:

- Home: index.md

- Installation: installation.md

- Development: development.md

- API Reference:

- reference/index.md

- Library:

- reference/lib/index.md

- Cache:

- reference/lib/cache/index.md

- Inmemory Cache: reference/lib/cache/inmemory.md

- Database:

- reference/lib/database/index.md

- SQLite Database: reference/lib/database/sqlite.md

- Repository:

- reference/lib/repos/index.md

- Decorators: reference/lib/repos/decorators.md

- Doctor Repository: reference/lib/repos/doctor.md

- Segment Repository: reference/lib/repos/segment.md

- Session Repository: reference/lib/repos/session.md

- Utterance Repository: reference/lib/repos/utterance.md

- Voiceprint Repository: reference/lib/repos/vp.md

- Exporter Server:

- reference/lib/server/index.md

- Auth Middleware: reference/lib/server/auth.md

- Handlers: reference/lib/server/handlers.md

- Types: reference/lib/server/types.md

- Store:

- reference/lib/store/index.md

- Localfile Store: reference/lib/store/localfile.md

- Transcription:

- reference/lib/transcription/index.md

- Events: reference/lib/transcription/events.md

- Dashscope Transcription: reference/lib/transcription/dashscope.md

- Voiceprint Recognition (VPR):

- reference/lib/vpr/index.md

- Unisound VPR:

- reference/lib/vpr/unisound/index.md

- Types: reference/lib/vpr/unisound/types.md

- XFyun VPR:

- reference/lib/vpr/xfyun/index.md

- Types: reference/lib/vpr/xfyun/types.md

- Websocket:

- reference/lib/websocket/index.md

- Websocket Connection: reference/lib/websocket/connection.md

- WebSocket Connection Pool (Async): reference/lib/websocket/pool.md

- Exporter: reference/lib/exporter.md

- Recorder: reference/lib/recorder.md

- RESTful Client: reference/lib/restful.md

- Session Manager: reference/lib/session.md

- USB Manager: reference/lib/usb.md