awl-python/zensical.toml at main · OO-LD/awl-python · 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
[project]
site_name = "awl-python"
repo_url = "https://github.com/OO-LD/awl-python"
site_url = "https://OO-LD.github.io/awl-python/"
site_description = "Python implementation of the Abstract Workflow Language (AWL-LD)"
site_author = "OO-LD Contributors"
edit_uri = "edit/main/docs/"
repo_name = "OO-LD/awl-python"
copyright = 'Maintained by <a href="https://github.com/OO-LD">OO-LD</a>.'

nav = [
    { "Home" = "index.md" },
    { "Flavours" = "flavours.md" },
    { "Worked examples" = "examples.md" },
    { "Editor" = "editor.md" },
    { "Editor specification" = "editor-spec.md" },
    { "Explainer" = "explainer.md" },
    { "API Reference" = "awl.md" },
    { "Development" = "dev.md" },
]

extra_css = ["assets/wide.css"]
# The theme ships mermaid's colour variables and not mermaid itself, so
# without this every diagram on the flavours page stays a block of text.
extra_javascript = ["assets/mermaid.js", "javascripts/explainer-player.js"]

[project.plugins.macros]
# The worked-examples page is built from the corpus at render time.
# An importable name, not a path: zensical resolves a path only against
# the project root, which arrives extended-length-prefixed under serve on
# Windows, and then silently renders no macros at all.
module_name = "awl.examples"

[project.plugins.mkdocstrings.handlers.python]
paths = ["src/awl"]

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "numpy"

[project.theme]
language = "en"
# Logo/favicon referenced directly from the OO-LD org so they stay in sync
# with the source of truth (no vendored copy to maintain).
logo = "https://raw.githubusercontent.com/OO-LD/schema/main/OO-LD_logo.jpg"
favicon = "https://raw.githubusercontent.com/OO-LD/schema/main/OO-LD_logo.jpg"
features = [
    "content.action.edit",
    "content.code.annotate",
    "content.code.copy",
    "navigation.footer",
    "navigation.indexes",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
]

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

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "white"
accent = "deep orange"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "black"
accent = "deep orange"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to system preference"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/OO-LD/awl-python"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/awl"

[project.markdown_extensions.attr_list]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.pymdownx.superfences]

# Design docs use mermaid diagrams.
#
# The class is deliberately not "mermaid". The theme claims that one, empties
# every element carrying it, and then renders nothing because it ships mermaid's
# colour variables and not mermaid itself: the fences arrived in the browser as
# ten empty divs. Under its own class the source survives for assets/mermaid.js
# to render.
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "mermaid"
class = "awl-mermaid"
format = "pymdownx.superfences.fence_code_format"

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

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true

[project.markdown_extensions.toc]
permalink = true