template/_zensical.toml at main · Quantum-Accelerators/template · 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
157
158
159
160
161
162
163
[project]
site_name = "template"
site_description = "This is the template package!"
site_author = "YourName"
repo_url = "https://github.com/Quantum-Accelerators/template/"
edit_uri = "blob/main/docs/"
use_directory_urls = false

nav = [
    { "Home" = "index.md" },
    { "Overview" = [
        "example_docs/intro/why.md",
        "example_docs/intro/resources.md"
    ] },
    { "Setup" = [
        "example_docs/setup/prep.md",
        "example_docs/setup/name.md",
        "example_docs/setup/basics.md"
    ] },
    { "Installation" = [
        "example_docs/installation/pyproject.md",
        "example_docs/installation/install.md"
    ] },
    { "Code" = [
        "example_docs/code/source.md",
        "example_docs/code/hints.md",
        "example_docs/code/tests.md"
    ] },
    { "Documentation" = [
        "example_docs/zensical/docs.md",
        "example_docs/zensical/build.md"
    ] },
    { "GitHub and CI" = [
        "example_docs/github/commits.md",
        "example_docs/github/workflows.md"
    ] },
    { "Code Documentation" = [
        "reference/"
    ] },
    { "About" = [
        "example_docs/about/changelog.md",
        "example_docs/about/conduct.md",
        "example_docs/about/license.md"
    ] }
]

[project.theme]
features = [
    "content.action.edit",
    "content.code.copy",
    "content.code.select",
    "content.code.annotate",
    "content.tabs.link",
    "content.tooltips",
    "navigation.footer",
    "navigation.path",
    "navigation.tracking",
    "navigation.sections",
    "navigation.top",
    "search.highlight",
    "search.suggest",
    "search.share",
    "header.autohide",
    "toc.follow"
]

[project.theme.palette]
primary = "orange"
scheme = "slate"

[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]
smart_enable = "all"

[project.markdown_extensions.pymdownx.caret]

[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.snippets]

[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

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

[project.markdown_extensions.pymdownx.tilde]

[project.plugins.search]
separator = '[\\s\\-,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])'

[project.plugins.autorefs]

# https://github.com/zensical/backlog/issues/37
[project.plugins.social]

[project.plugins.offline]

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

[project.plugins.mkdocstrings.handlers.python]
inventories = [
    "https://docs.python.org/3/objects.inv",
    "https://numpy.org/doc/stable/objects.inv"
]

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "numpy"
docstring_section_style = "list"
separate_signature = true
merge_init_into_class = true
show_signature_annotations = true
signature_crossrefs = true
show_if_no_docstring = true

[project.plugins.mkdocstrings.handlers.python.options.docstring_options]
ignore_init_summary = true

# https://github.com/zensical/backlog/issues/8
[project.plugins.gen-files]
scripts = ["docs/gen_ref_pages.py"]

# https://github.com/zensical/backlog/issues/13
[project.plugins.literate-nav]
nav_file = "SUMMARY.md"