affinis/zensical.toml at main · rtbs-dev/affinis · 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
[project]

site_name = "Affinis"

site_description = "A new project generated from the default template project."
site_author = "Rachael Sexton"
#site_url = "https://www.example.com/"

copyright = """
Affinis and all of it's associated documentation are in the public domain (see the <a href="https://github.com/usnistgov/affinis/blob/main/LICENSE.md"> license </a>)
"""
nav = [
  {"Home" = "index.md"},
  {"Installation" = "install.md"},
  { "User Guide" = [
      "user-guide/associations.md",
      "user-guide/smoothing.md",
      "user-guide/dist-prox.md",
        # "using/psdct.md"
    ]},
  {"Examples" = ["case-studies/example.md"]},

    # [
        # "getting-started/01-installation.md",
        # "getting-started/02-tutorial.md",
        # "getting-started/03-performance.md"
    # ]
  # },
  { "API" = [
        'api/associations.md',
        'api/plots.md',
        'api/priors.md',
        'api/proximity.md',
        'api/distance.md',
        'api/filters.md',
        'api/types.md',

  ]},
]
# nav = [
#   { "Get started" = "index.md" },
#   { "Markdown in 5min" = "markdown.md" },
# ]
#extra_css = ["stylesheets/extra.css"]

extra_css = [
  "https://pages.nist.gov/nist-header-footer/css/nist-combined.css",
  "css/mkdocstrings.css"
]
extra_javascript = [
  "javascripts/mathjax.js",
  "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js",
  "https://pages.nist.gov/nist-header-footer/js/jquery-1.9.0.min.js",
  "https://pages.nist.gov/nist-header-footer/js/nist-header-footer.js",
]

[project.markdown_extensions.footnotes]
[project.markdown_extensions.admonition]

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

[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.attr_list]

[project.theme]

#custom_dir = "overrides"
favicon = "images/favicon.png"
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",
]

[[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.theme.font]
text = "Rubik"
code = "Fira Code"

#[project.theme.icon]
#logo = "lucide/smile"
#repo = "lucide/smile"

[[project.extra.social]]
name = "USNISTGOV on GitHub"
icon = "fontawesome/brands/github"
link = "https://github.com/usnistgov/affinis"


[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]

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

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
inherited_members = true
# show_source = false
# backlinks = "tree"
docstring_options = {ignore_init_summary = true}
docstring_section_style = "list"
# extensions = ["griffe_typingdoc",]
filters = ["!^_", "^__"]
heading_level = 1
# merge_init_into_class = true
parameter_headings = true
separate_signature = true
show_root_heading = true
show_root_full_path = false
show_signature_annotations = true
show_source = true
show_symbol_type_heading = true
show_symbol_type_toc = true
show_docstring_type_aliases = true
signature_crossrefs = true
summary = true
unwrap_annotated = true