FilesExpand file tree

main

/

zensical.toml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

215 lines (199 loc) · 7.05 KB

main

/

zensical.toml

Copy path

Top

File metadata and controls

• Code
• Blame

215 lines (199 loc) · 7.05 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

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

[project]

site_name = "mkdocstrings"

site_description = "Automatic documentation from sources, for MkDocs."

site_author = "Timothée Mazzucotelli"

site_url = "https://mkdocstrings.github.io/mkdocstrings"

repo_url = "https://github.com/mkdocstrings/mkdocstrings"

repo_name = "mkdocstrings/mkdocstrings"

edit_uri = "edit/main/docs/"

copyright = "Copyright © 2019 Timothée Mazzucotelli"

extra_css = ["css/apidocs.css"]

extra_javascript = ["js/feedback.js"]

nav = [

{ "Home" = [

{ "Overview" = "index.md" },

{ "Changelog" = "changelog.md" },

{ "Credits" = "credits.md" },

{ "License" = "license.md" },

] },

{ "Usage" = [

"usage/index.md",

{ "Theming" = "usage/theming.md" },

{ "Handlers" = "usage/handlers.md" },

{ "All handlers" = [

{ "C" = "https://mkdocstrings.github.io/c/" },

{ "Crystal" = "https://mkdocstrings.github.io/crystal/" },

{ "GitHub Actions" = "https://watermarkhu.nl/mkdocstrings-github/" },

{ "Python" = "https://mkdocstrings.github.io/python/" },

{ "Python (Legacy)" = "https://mkdocstrings.github.io/python-legacy/" },

{ "MATLAB" = "https://watermarkhu.nl/mkdocstrings-matlab/" },

{ "Shell" = "https://mkdocstrings.github.io/shell/" },

{ "TypeScript" = "https://mkdocstrings.github.io/typescript/" },

{ "VBA" = "https://mkdocstrings.github.io/vba/" },

] },

{ "Guides" = [

{ "Recipes" = "recipes.md" },

{ "Troubleshooting" = "troubleshooting.md" },

] },

] },

{ "API reference" = "reference/api.md" },

{ "Development" = [

{ "Contributing" = "contributing.md" },

{ "Code of Conduct" = "code_of_conduct.md" },

] },

{ "Author's website" = "https://pawamoy.github.io" },

]

# ----------------------------------------------------------------------------

# Theme configuration

# ----------------------------------------------------------------------------

[project.theme]

logo = "logo.svg"

custom_dir = "docs/.overrides"

language = "en"

features = [

"announce.dismiss",

"content.action.edit",

"content.action.view",

"content.code.annotate",

"content.code.copy",

"content.code.select",

"content.footnote.tooltips",

"content.tabs.link",

"content.tooltips",

"navigation.footer",

"navigation.indexes",

"navigation.instant",

"navigation.instant.prefetch",

"navigation.path",

"navigation.sections",

"navigation.tabs",

"navigation.tabs.sticky",

"navigation.top",

"search.highlight",

"toc.follow",

]

[[project.theme.palette]]

media = "(prefers-color-scheme)"

toggle.icon = "material/brightness-auto"

toggle.name = "Switch to light mode"

[[project.theme.palette]]

media = "(prefers-color-scheme: light)"

scheme = "default"

primary = "teal"

accent = "purple"

toggle.icon = "material/weather-sunny"

toggle.name = "Switch to dark mode"

[[project.theme.palette]]

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

scheme = "slate"

primary = "black"

accent = "lime"

toggle.icon = "material/weather-night"

toggle.name = "Switch to system preference"

[project.theme.icon]

logo = "material/currency-sign"

# ----------------------------------------------------------------------------

# Social configuration

# ----------------------------------------------------------------------------

[[project.extra.social]]

icon = "fontawesome/brands/github"

link = "https://github.com/pawamoy"

[[project.extra.social]]

icon = "fontawesome/brands/mastodon"

link = "https://fosstodon.org/@pawamoy"

[[project.extra.social]]

icon = "fontawesome/brands/twitter"

link = "https://twitter.com/pawamoy"

[[project.extra.social]]

icon = "fontawesome/brands/gitter"

link = "https://gitter.im/mkdocstrings/community"

[[project.extra.social]]

icon = "fontawesome/brands/python"

link = "https://pypi.org/project/mkdocstrings/"

[project.extra.analytics.feedback]

title = "Was this page helpful?"

[[project.extra.analytics.feedback.ratings]]

icon = "material/emoticon-happy-outline"

name = "This page was helpful"

data = 1

note = "Thank you for your feedback!"

[[project.extra.analytics.feedback.ratings]]

icon = "material/emoticon-sad-outline"

name = "This page could be improved"

data = 0

note = "Let us know how we can improve this page."

# ----------------------------------------------------------------------------

# Markdown extensions configuration

# ----------------------------------------------------------------------------

[project.markdown_extensions.abbr]

[project.markdown_extensions.admonition]

[project.markdown_extensions.attr_list]

[project.markdown_extensions.callouts]

[project.markdown_extensions.def_list]

[project.markdown_extensions.footnotes]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.toc]

permalink = "¤"

[project.markdown_extensions.pymdownx.arithmatex]

generic = true

[project.markdown_extensions.pymdownx.betterem]

smart_enable = "all"

[project.markdown_extensions.pymdownx.caret]

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.emoji]

emoji_generator = "zensical.extensions.emoji.to_svg"

emoji_index = "zensical.extensions.emoji.twemoji"

[project.markdown_extensions.pymdownx.highlight]

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.pymdownx.keys]

[project.markdown_extensions.pymdownx.magiclink]

[project.markdown_extensions.pymdownx.mark]

[project.markdown_extensions.pymdownx.smartsymbols]

[project.markdown_extensions.pymdownx.snippets]

check_paths = true

[project.markdown_extensions.pymdownx.superfences]

[[project.markdown_extensions.pymdownx.superfences.custom_fences]]

name = "python"

class = "python"

validator = "markdown_exec.validator"

format = "markdown_exec.formatter"

[project.markdown_extensions.pymdownx.tabbed]

alternate_style = true

[project.markdown_extensions.pymdownx.tasklist]

custom_checkbox = true

[project.markdown_extensions.pymdownx.tilde]

[project.markdown_extensions.zensical.extensions.preview]

configurations = [{targets.include = ["reference/api.md"]}]

# ----------------------------------------------------------------------------

# Plugins configuration

# ----------------------------------------------------------------------------

[project.plugins.mkdocstrings.handlers.python]

paths = ["src"]

inventories = [

"https://docs.python.org/3/objects.inv",

"https://installer.readthedocs.io/en/stable/objects.inv", # demonstration purpose in the docs

"https://mkdocstrings.github.io/autorefs/objects.inv",

"https://www.mkdocs.org/objects.inv",

"https://python-markdown.github.io/objects.inv",

"https://jinja.palletsprojects.com/en/stable/objects.inv",

"https://markupsafe.palletsprojects.com/en/stable/objects.inv",

]

[project.plugins.mkdocstrings.handlers.python.options]

backlinks = "tree"

docstring_options = { "ignore_init_summary" = true }

docstring_section_style = "list"

filters = "public"

heading_level = 1

inherited_members = true

merge_init_into_class = true

parameter_headings = true

separate_signature = true

show_root_heading = true

show_root_full_path = false

show_signature_annotations = true

show_source = true

show_symbol_type_heading = true

show_symbol_type_toc = true

signature_crossrefs = true

summary = true

unwrap_annotated = true