faststream_fastapi/zensical.toml at develop · faststream-community/faststream_fastapi · GitHub

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
[project]
site_name = "faststream_fastapi"
site_description = "FastAPI plugin for FastStream"
site_author = "Ivan Kirpichnikov"
# site_url = "https://www.example.com/"

copyright = "Copyright &copy; 2026 Ivan Kirpichnikov"

nav = [
  { "Get started" = [
    { "Get started" = "index.md" },
  ] },
  { "Dependencies" = [
    { "Dependencies" = "dependencies/index.md" },
  ] },
  { "Context" = [
    { "Context" = "context/index.md" },
  ] },
  { "Background tasks" = [
    { "Background tasks" = "background_tasks/index.md" },
  ] },
  { "Lifespan" = [
    { "Lifespan" = "lifespan/index.md" },
  ] },
  { "AsyncAPI" = [
    { "Schema export" = "asyncapi/schema_export.md" },
    { "AsyncAPI Configure" = "asyncapi/asyncapi_configure.md" },
  ] },
  { "Testing" = [
    { "Testing" = "testing/index.md" },
  ] },
  { "Low API" = [
    { "Connection" = "low_api/connection/index.md"}
  ] }
]

[project.theme]
variant = "modern"
#custom_dir = "overrides"
favicon = "assets/logo.svg"

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",
  "header.autohide",
  "navigation.expand",
  "navigation.footer",
  "navigation.indexes",
  "navigation.instant",
  "navigation.instant.prefetch",
  "navigation.instant.progress",
  "navigation.path",
  "navigation.prune",
  "navigation.sections",
  # "navigation.tabs",
  "navigation.tabs.sticky",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  "toc.follow",
  "toc.integrate",
]

logo = "assets/logo.svg"

[project.theme.font]
text = "Inter"
code = "Jetbrains Mono"

[[project.theme.palette]]
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/faststream-community/faststream_fastapi"

[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = true

[project.markdown_extensions.pymdownx.arithmatex]
generic = true

[project.markdown_extensions.pymdownx.betterem]
[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]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
auto_title = true

[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.superfences]
custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

[project.markdown_extensions.pymdownx.tilde]

[project.markdown_extensions.mkdocstrings]
default_handler = "python"

[project.markdown_extensions.mkdocstrings.handlers.python]
import = "https://docs.python.org/3/objects.inv"

[project.markdown_extensions.mkdocstrings.handlers.python.options]
show_root_heading = true
show_if_no_docstring = true
inherited_members = true
members_order = "source"
separate_signature = true
unwrap_annotated = true
merge_init_into_class = true
docstring_section_style = "spacy"
signature_crossrefs = true
show_symbol_type_heading = true
show_symbol_type_toc = true
show_docstring_attributes = false
show_signature_annotations = true
load_external_modules = true