pyinfra/zensical.toml at 3.x · pyinfra-dev/pyinfra · 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
[project]
site_name = "pyinfra"
site_url = "https://docs.pyinfra.com/"
site_description = "pyinfra automates infrastructure using idempotent Python operations."
site_author = "Nick Barrett"
copyright = "© 2015–2026 · pyinfra and contributors"
repo_url = "https://github.com/pyinfra-dev/pyinfra"
repo_name = "pyinfra-dev/pyinfra"
docs_dir = "docs"
site_dir = "build/docs"
use_directory_urls = false

extra_css = ["assets/pyinfra.css"]
extra_javascript = []

nav = [
    { "Home" = "index.md" },
    { "Using pyinfra" = [
        { "Getting Started" = "getting-started.md" },
        { "Using Operations" = "using-operations.md" },
        { "Inventory & Data" = "inventory-data.md" },
        { "Using the CLI" = "cli.md" },
        { "FAQ" = "faq.md" },
    ] },
    { "Deploy Reference" = [
        { "Operations" =  "operations.html" },
        { "Facts" = "facts.md" },
        { "Connectors" = "connectors.md" },
        { "Arguments" = "arguments.md" },
    ] },
    { "How pyinfra Works" = [
        { "Deploy Process" = "deploy-process.md" },
        { "Packaging Deploys" = "api/deploys.md" },
        { "Writing Connectors" = "api/connectors.md" },
        { "Writing Operations" = "api/operations.md" },
        { "Writing Facts" = "api/facts.md" },
        { "Using the API" = "api/index.md" },
    ] },
    { "Meta" = [
        { "Support" = "support.md" },
        { "Contributing" = "contributing.md" },
        { "Compatibility" = "compatibility.md" },
        { "Performance" = "performance.md" },
        { "LLM-friendly docs" = "llms.md" },
        { "Changelog" = "changes.md" },
        { "API Reference" = "api/reference.md" },
    ] },
]

[project.theme]
name = "zensical"
variant = "modern"
custom_dir = "overrides"
logo = "static/logo_small.png"
favicon = "static/logo_small.png"
features = [
    "navigation.sections",
    # "navigation.indexes",
    "navigation.top",
    "navigation.tracking",
    # "navigation.expand",
    "toc.follow",
    "content.code.copy",
    "content.code.annotate",
]

[[project.theme.palette]]
media = "(prefers-color-scheme)"

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "pyinfra"
accent = "pyinfra"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "pyinfra"
accent = "pyinfra"

[project.extra]
generator = false
primary_doc_version = "3.x"
doc_versions = ["3.x", "2.x", "1.x", "0.x", "latest"]
docs_language = "en"
plausible_domain = "docs.pyinfra.com"
plausible_stats_domain = "stats.oxygem.com"

[project.markdown_extensions]
abbr = {}
admonition = {}
attr_list = {}
def_list = {}
footnotes = {}
md_in_html = {}
tables = {}

[project.markdown_extensions.toc]
permalink = true
toc_depth = 3

[project.markdown_extensions."pymdownx.details"]
[project.markdown_extensions."pymdownx.highlight"]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = 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.snippets"]
base_path = [".", "snippets"]
check_paths = true
[project.markdown_extensions."pymdownx.superfences"]
[project.markdown_extensions."pymdownx.tabbed"]
alternate_style = true
[project.markdown_extensions."pymdownx.tasklist"]
custom_checkbox = true
[project.markdown_extensions."pymdownx.tilde"]

[project.plugins.search]

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

[project.plugins.mkdocstrings.handlers.python]
paths = ["src"]
inventories = ["https://docs.python.org/3/objects.inv"]

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
docstring_section_style = "table"
inherited_members = true
members_order = "source"
show_root_heading = true
show_source = false
show_signature_annotations = true
separate_signature = true
merge_init_into_class = true
show_symbol_type_heading = true
show_symbol_type_toc = true