FilesExpand file tree

render-docstrings

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

335 lines (327 loc) · 10.5 KB

render-docstrings

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

335 lines (327 loc) · 10.5 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

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

site_name: "Griffe"

site_description: "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API."

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

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

repo_name: "mkdocstrings/griffe"

site_dir: "site"

watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, packages]

copyright: Copyright © 2021 Timothée Mazzucotelli

edit_uri: edit/main/docs/

validation:

omitted_files: warn

absolute_links: warn

unrecognized_links: warn

not_in_nav: |

usage.md

nav:

- Home: index.md

- Getting started:

- getting-started.md

- Installation: installation.md

- Introduction: introduction.md

- Playground: playground.md

- License: license.md

- Community:

- community.md

- Getting help: getting-help.md

- Contributing: contributing.md

- Code of conduct: code-of-conduct.md

- Alternatives: alternatives.md

- Downstream projects: downstream-projects.md

- Credits: credits.md

- Guide:

- guide.md

- User guide:

- guide/users.md

- Manipulating APIs:

- Loading: guide/users/loading.md

- Navigating: guide/users/navigating.md

- Serializing: guide/users/serializing.md

- Checking: guide/users/checking.md

- Extending: guide/users/extending.md

- Recommendations:

- Public APIs: guide/users/recommendations/public-apis.md

- Python code: guide/users/recommendations/python-code.md

- Docstrings: guide/users/recommendations/docstrings.md

- How-to:

- Parse docstrings: guide/users/how-to/parse-docstrings.md

- Support custom decorators: guide/users/how-to/support-decorators.md

- Selectively inspect objects: guide/users/how-to/selectively-inspect.md

- Set objects' docstring style: guide/users/how-to/set-docstring-styles.md

- Set Git info on objects: guide/users/how-to/set-git-info.md

- Contributor guide:

- guide/contributors.md

- Environment setup: guide/contributors/setup.md

- Management commands: guide/contributors/commands.md

- Development workflow: guide/contributors/workflow.md

- Project architecture: guide/contributors/architecture.md

- Coverage report: guide/contributors/coverage.md

- Extensions:

- extensions.md

- Built-in:

- extensions/built-in.md

- dataclasses: extensions/built-in/dataclasses.md

- unpack-typeddict: extensions/built-in/unpack-typeddict.md

- Official:

- extensions/official.md

- autodocstringstyle: extensions/official/autodocstringstyle.md

- inherited-docstrings: extensions/official/inherited-docstrings.md

- public-redundant-aliases: extensions/official/public-redundant-aliases.md

- public-wildcard-imports: extensions/official/public-wildcard-imports.md

- pydantic: extensions/official/pydantic.md

- runtime-objects: extensions/official/runtime-objects.md

- sphinx: extensions/official/sphinx.md

- typingdoc: extensions/official/typingdoc.md

- warnings-deprecated: extensions/official/warnings-deprecated.md

- Third-party:

- extensions/third-party.md

- docstring-inheritance: extensions/third-party/docstring-inheritance.md

- fastapi: extensions/third-party/fastapi.md

- fieldz: extensions/third-party/fieldz.md

- generics: extensions/third-party/generics.md

- inherited-method-crossrefs: extensions/third-party/inherited-method-crossrefs.md

- modernized-annotations: extensions/third-party/modernized-annotations.md

- Reference:

- reference.md

- Command-line interface: reference/cli.md

- Docstring parsers: reference/docstrings.md

- Python API:

- reference/api.md

- CLI entrypoints: reference/api/cli.md

- Loaders: reference/api/loaders.md

- Finder: reference/api/finder.md

- Models:

- reference/api/models.md

- Module: reference/api/models/module.md

- Class: reference/api/models/class.md

- Function: reference/api/models/function.md

- Attribute: reference/api/models/attribute.md

- Type Alias: reference/api/models/type_alias.md

- Alias: reference/api/models/alias.md

- Agents: reference/api/agents.md

- Serializers: reference/api/serializers.md

- API checks: reference/api/checks.md

- Extensions: reference/api/extensions.md

- Docstrings:

- reference/api/docstrings.md

- Models: reference/api/docstrings/models.md

- Parsers: reference/api/docstrings/parsers.md

- Exceptions: reference/api/exceptions.md

- Expressions: reference/api/expressions.md

- Loggers: reference/api/loggers.md

- Helpers: reference/api/helpers.md

- Changelog: changelog.md

- Author's website: https://pawamoy.github.io/

theme:

name: material

custom_dir: docs/.overrides

logo: logo.svg

favicon: img/favicon.ico

features:

- announce.dismiss

- content.action.edit

- content.action.view

- content.code.annotate

- content.code.copy

- content.tooltips

- navigation.expand

- navigation.footer

- navigation.instant.preview

- navigation.path

- navigation.sections

- navigation.tabs

- navigation.tabs.sticky

- navigation.top

- search.highlight

- search.suggest

- toc.follow

palette:

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

toggle:

icon: material/brightness-auto

name: Switch to light mode

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

scheme: default

primary: teal

accent: purple

toggle:

icon: material/weather-sunny

name: Switch to dark mode

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

scheme: slate

primary: black

accent: lime

toggle:

icon: material/weather-night

name: Switch to system preference

extra_css:

- css/custom.css

- css/material.css

- css/mkdocstrings.css

extra_javascript:

- js/feedback.js

- https://cdn.jsdelivr.net/npm/svg-pan-zoom@3.6.1/dist/svg-pan-zoom.min.js

markdown_extensions:

- attr_list

- admonition

- callouts:

strip_period: no

- footnotes

- md_in_html

- pymdownx.blocks.tab:

alternate_style: true

- pymdownx.emoji:

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

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

- pymdownx.keys

- pymdownx.magiclink

- pymdownx.snippets:

base_path: [!relative $config_dir]

check_paths: true

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

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

- pymdownx.tabbed:

alternate_style: true

slugify: !!python/object/apply:pymdownx.slugs.slugify

kwds:

case: lower

- pymdownx.tasklist:

custom_checkbox: true

- toc:

permalink: "¤"

plugins:

- search

- autorefs

- markdown-exec:

ansi: required

- gen-files:

scripts:

- scripts/gen_griffe_json.py

- section-index

- coverage:

page_path: guide/contributors/coverage

- mkdocstrings:

enabled: !ENV [MKDOCSTRINGS_ENABLED, true]

handlers:

python:

inventories:

- url: https://docs.python.org/3/objects.inv

domains: [std, py]

- https://typing-extensions.readthedocs.io/en/latest/objects.inv

paths: [packages/griffelib/src, packages/griffecli/src, scripts, .]

options:

backlinks: tree

docstring_options:

per_style_options:

google:

ignore_init_summary: true

docstring_style: auto

docstring_section_style: list

extensions:

- griffe_inherited_docstrings

- unpack_typeddict

heading_level: 2

inherited_members: true

merge_init_into_class: true

parameter_headings: true

separate_signature: true

show_bases: true

show_inheritance_diagram: 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

- llmstxt:

enabled: !ENV [DEPLOY, false]

full_output: llms-full.txt

sections:

Usage:

- index.md

- getting-started.md

- installation.md

- introduction.md

- guide/users.md

- guide/users/loading.md

- guide/users/navigating.md

- guide/users/serializing.md

- guide/users/checking.md

- guide/users/extending.md

Recommendations:

- guide/users/recommendations/*

How-to:

- guide/users/how-to/*

Reference:

- reference/cli.md

- reference/docstrings.md

- reference/api.md

- reference/api/*

Extensions:

- extensions/built-in.md

- extensions/built-in/*

- extensions/official.md

- extensions/official/*

- extensions/third-party.md

- extensions/third-party/*

Contributing:

- guide/contributors.md

- guide/contributors/*

Other:

- license.md

- community.md

- getting-help.md

- code-of-conduct.md

- alternatives.md

- downstream-projects.md

- credits.md

- changelog.md

- git-revision-date-localized:

enabled: !ENV [DEPLOY, false]

enable_creation_date: true

type: timeago

- minify:

minify_html: !ENV [DEPLOY, false]

- redirects:

redirect_maps:

cli_reference.md: reference/cli.md

checking.md: guide/users/checking.md

dumping.md: guide/users/serializing.md

loading.md: guide/users/loading.md

expressions.md: guide/users/navigating.md#expressions

best_practices.md: guide/users/recommendations/python-code.md

docstrings.md: reference/docstrings.md

parsing_docstrings.md: guide/users/how-to/parse-docstrings.md

try_it_out.md: playground.md

reference/griffe.md: reference/api.md

code_of_conduct.md: code-of-conduct.md

- typeset

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/pawamoy

- icon: fontawesome/brands/mastodon

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

- icon: fontawesome/brands/twitter

link: https://twitter.com/pawamoy

- icon: fontawesome/brands/gitter

link: https://gitter.im/griffe/community

- icon: fontawesome/brands/python

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

analytics:

feedback:

title: Was this page helpful?

ratings:

- icon: material/emoticon-happy-outline

name: This page was helpful

data: 1

note: Thanks for your feedback!

- icon: material/emoticon-sad-outline

name: This page could be improved

data: 0

note: Let us know how we can improve this page.