pyochain/zensical.toml at master · OutSquareCapital/pyochain · 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
[project]
    site_author      = "Thibaud Wilson Stettler"
    site_description = "A modern Python library for functional programming with chainable operations"
    site_name        = "pyochain"
    site_url         = "https://outsquarecapital.github.io/pyochain/"

    docs_dir         = "docs"
    extra_javascript = ["javascripts/mermaid.mjs"]
    site_dir         = "site"

    nav = [
        { "API Reference" = [
            { "Collections" = [
                { "Dict" = "reference/dict.md" },
                { "Seq" = "reference/seq.md" },
                { "Set" = "reference/set.md" },
                { "SetMut" = "reference/setmut.md" },
                { "Vec" = "reference/vec.md" },
            ] },
            { "Error Handling" = [
                { "Err" = "reference/err.md" },
                { "Ok" = "reference/ok.md" },
                { "Result" = "reference/result.md" },
                { "ResultUnwrapError" = "reference/resultunwraperror.md" },
            ] },
            { "Iterators" = [
                { "Iter" = "reference/iter.md" },
                { "Peekable" = "reference/peekable.md" },
                { "Unzipped" = "reference/unzipped.md" },
            ] },
            { "Optional Values" = [
                { "None" = "reference/noneoption.md" },
                { "Option" = "reference/option.md" },
                { "OptionUnwrapError" = "reference/optionunwraperror.md" },
                { "Some" = "reference/some.md" },
            ] },
            { "Overview" = "api-reference.md" },
            { "Traits & Mixins" = [
                { "Checkable" = "reference/checkable.md" },
                { "Pipeable" = "reference/pipeable.md" },
                { "PyoCollection" = "reference/pyocollection.md" },
                { "PyoItemsView" = "reference/pyoitemsview.md" },
                { "PyoIterable" = "reference/pyoiterable.md" },
                { "PyoIterator" = "reference/pyoiterator.md" },
                { "PyoKeysView" = "reference/pyokeysview.md" },
                { "PyoMapping" = "reference/pyomapping.md" },
                { "PyoMappingView" = "reference/pyomappingview.md" },
                { "PyoMutableMapping" = "reference/pyomutablemapping.md" },
                { "PyoMutableSequence" = "reference/pyomutablesequence.md" },
                { "PyoSequence" = "reference/pyosequence.md" },
                { "PyoSet" = "reference/pyoset.md" },
                { "PyoValuesView" = "reference/pyovaluesview.md" },
            ] },
        ] },
        { "Getting Started" = [
            { "Core Types Overview" = "core-types-overview.md" },
            { "Examples" = "examples.md" },
            { "Interoperability" = "interoperability.md" },
            { "Overview" = "getting-started.md" },
        ] },
        { "Home" = "index.md" },
    ]

    [project.theme]
        palette = [
            { media = "(prefers-color-scheme: dark)", scheme = "slate", primary = "indigo", accent = "indigo", toggle = { icon = "lucide/moon", name = "Switch to light mode" } },
            { media = "(prefers-color-scheme: light)", scheme = "default", primary = "indigo", accent = "indigo", toggle = { icon = "lucide/sun", name = "Switch to dark mode" } },
        ]
        paths = ["src"]

    [project.plugins.mkdocstrings.handlers.python.options]
        docstring_style     = "google"
        filters             = ["!^_[^_]"]
        inherited_members   = false
        members_order       = "alphabetical"
        scoped_crossrefs    = true
        show_overloads      = true
        show_source         = true
        signature_crossrefs = true


    [project.markdown_extensions.pymdownx.superfences]
        custom_fences = [
            { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
        ]

    [project.markdown_extensions."mkdocs_autorefs._internal.references:AutorefsExtension"]