zensical.toml

[project]
site_name = "Object Oriented Linked Data (OOLD)"
repo_url = "https://github.com/OO-LD/oold-python"
site_url = "https://OO-LD.github.io/oold-python/"
site_description = "Linked data class python package"
site_author = "OO-LD Contributors"
edit_uri = "edit/main/docs/"
repo_name = "OO-LD/oold-python"
copyright = 'Maintained by <a href="https://github.com/OO-LD">OO-LD</a>.'

extra_css = ["stylesheets/extra.css"]

nav = [
    { "Home" = "index.md" },
    { "About" = "about.md" },
    { "Get Started" = "get-started.md" },
    { "How to Use" = [
        { "Overview" = "how-to/index.md" },
        { "Code Generation" = "how-to/codegen.md" },
        { "Object Graph Mapping" = "how-to/object-graph-mapping.md" },
        { "Backends" = "how-to/backends.md" },
        { "RDF Export" = "how-to/rdf-export.md" },
        { "Validation" = "how-to/validation.md" },
        { "BaseController" = "how-to/controller.md" },
    ]},
    { "Architecture" = "architecture.md" },
    { "Contributing" = [
        { "Contributing" = "contributing.md" },
        { "Maintaining meta-schemas" = "maintaining-meta-schemas.md" },
    ]},
    { "API Reference" = "api.md" },
]

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

[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 = [
    "announce.dismiss",
    "content.code.annotate",
    "content.action.edit",
    "content.action.view",
    "content.code.copy",
    "content.code.select",
    "content.footnote.tooltips",
    "content.tabs.link",
    "content.tooltips",
    "navigation.footer",
    "navigation.indexes",
    "navigation.tabs",
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.path",
    "navigation.prune",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
]


[project.theme.icon]
previous = "fontawesome/solid/angle-left"
next = "fontawesome/solid/angle-right"
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/oold-python"

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

# ===========================================================================
# BEGIN Zensical defaults - restated, not project choices
#
# Zensical enables a set of Markdown extensions out of the box, but a project
# that declares ANY markdown_extensions REPLACES that set instead of extending
# it: zensical/config.py reads them via
#     config.get("markdown_extensions", DEFAULT_MARKDOWN_EXTENSIONS)
# which is a fallback, not a merge. Every default left out here is therefore
# silently switched off, with no warning and no build failure - the extension
# just stops applying. That is how the `!!! note` / `!!! tip` admonitions in
# how-to/backends.md, how-to/codegen.md, how-to/object-graph-mapping.md and
# how-to/rdf-export.md ended up published as literal text.
#
# The entries below reproduce the Markdown extension defaults of the "zensical"
# dev dependency pinned in pyproject.toml, so the effective set is visible in
# one file rather than hiding behind a fallback. scripts/check_markdown_extensions.py
# (run via `make check-extensions`) compares this block against the installed
# Zensical's DEFAULT_MARKDOWN_EXTENSIONS and fails the build if they drift, so
# upgrading zensical cannot change the effective set unnoticed.
#
# This project has no deviations from those defaults: a bare pymdownx.arithmatex,
# a pymdownx.tabbed missing combine_header_slug, and an explicit "format" on the
# mermaid fence used to differ from the default without a stated reason, and
# none of them turned out to be needed (the mermaid fence's "format" defaults to
# the exact same function - pymdownx.superfences.fence_code_format - when left
# unset, see pymdownx/superfences.py). They were restored to match the default
# rather than kept as unexplained overrides. See the note next to
# pymdownx.smartsymbols below for the one entry that got deliberate thought
# rather than a blanket restore.
# ===========================================================================

[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.pymdownx.betterem]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.magiclink]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.tilde]

# Zensical enables this by default. It silently rewrites sequences such as
# (c), (r), (tm), +/-, -->, <--, =/= and fractions like 1/2 wherever they
# appear in prose - a sibling OO-LD project found it turning the "(c)" of an
# (a)/(b)/(c) enumeration into a copyright sign. docs/ here were checked for
# those sequences outside code fences: the only matches are the "-->" arrows
# of Mermaid diagrams, all inside ```mermaid fences in architecture.md, which
# smartsymbols never touches (fenced code content is not run through inline
# extensions). With no prose depending on a literal (c)/(r)/1/2/etc. found,
# this stays enabled as shipped. If that changes, move this table above the
# "END Zensical defaults" marker with a comment, and add it to
# INTENTIONALLY_DISABLED in scripts/check_markdown_extensions.py.
[project.markdown_extensions.pymdownx.smartsymbols]

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

[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.superfences]

[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "mermaid"
class = "mermaid"

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

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

[project.markdown_extensions.toc]
permalink = true

# ===========================================================================
# END Zensical defaults
# ===========================================================================

# No project-specific extensions or overrides at the moment: everything this
# project needs turned out to already be a Zensical default. If a genuine
# override or addition becomes necessary, add it here and record it in
# scripts/check_markdown_extensions.py's INTENTIONAL_OVERRIDES or
# PROJECT_ADDITIONS so the guard keeps checking it deliberately instead of
# flagging it as drift.