modmail-v5-development/zensical.toml at v5-development · modmail-dev/modmail-v5-development · 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
[project]
site_name = "Modmail"
site_url = "https://docs.modmail.dev"
site_description = "A Discord DM-based support ticket bot."
site_author = "Modmail Team"
docs_dir = "docs"
site_dir = "site"
repo_url = "https://LINK_TO_GITHUB_REPO"

[project.theme]
variant = "modern"
features = [
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.instant.progress",
    "navigation.tracking",
    # "navigation.tabs",
    "navigation.sections",
    # "navigation.expand",
    "navigation.path",
    "navigation.indexes",
    "toc.follow",
    # "toc.integrate",
    "navigation.top",
    "search.highlight",
    "navigation.footer",
    "content.tooltips",
]

[project.theme.icon]
repo = "fontawesome/brands/github"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://LINK_TO_GITHUB_REPO"

[[project.extra.social]]
icon = "fontawesome/brands/discord"
link = "https://LINK_TO_DISCORD_SERVER"

[project.plugins.mkdocstrings.handlers.python]
paths = [".", "modmail"]
inventories = [
    "https://docs.python.org/3/objects.inv",
    "https://discordpy.readthedocs.io/en/stable/objects.inv",
    "https://docs.sqlalchemy.org/en/20/objects.inv",
    "https://docs.pydantic.dev/latest/objects.inv",
    "https://pymongo.readthedocs.io/en/stable/objects.inv",
]

[project.plugins.mkdocstrings.handlers.python.options]
#preload_modules = ["modmail"]
extensions = [
    {griffe_pydantic = {schema = true}},
]
show_source = true
show_root_heading = true
show_symbol_type_heading = true
show_symbol_type_toc = true
members_order = "source"
show_submodules = false
docstring_style = "google"
docstring_section_style = "table"
merge_init_into_class = true
relative_crossrefs = true
scoped_crossrefs = true
show_if_no_docstring = true
annotations_path = "brief"
line_length = 105
modernize_annotations = true
overloads_only = true
show_signature_annotations = true
separate_signature = true
signature_crossrefs = true
filters = [
    "!^_[^_]",
    "!^__all__$",
    "!^__str__$",
    "!^logger$",
    "!^model_config$",
]

[project.plugins.mkdocstrings.handlers.python.options.docstring_options]
returns_named_value = false