zensical.toml

# ============================================================================
#
# The configuration produced by default is meant to highlight the features
# that Zensical provides and to serve as a starting point for your own
# projects.
#
# ============================================================================

[project]

site_dir = "site"
repo_name = "saforem2/ezpz"
repo_url = "https://github.com/saforem2/ezpz"
edit_uri = "edit/main/docs"

# The site_name is shown in the page header and the browser window title
#
# Read more: https://zensical.org/docs/setup/basics/#site_name
site_name = "ezpz"

# The site_description is included in the HTML head and should contain a
# meaningful description of the site content for use by search engines.
#
# Read more: https://zensical.org/docs/setup/basics/#site_description
site_description = "Distributed PyTorch across any hardware, ezpz."

# The site_author attribute. This is used in the HTML head element.
#
# Read more: https://zensical.org/docs/setup/basics/#site_author
site_author = "Sam Foreman"

# The site_url is the canonical URL for your site. When building online
# documentation you should set this.
# Read more: https://zensical.org/docs/setup/basics/#site_url
site_url = "https://ezpz.cool"

# The copyright notice appears in the page footer and can contain an HTML
# fragment.
#
# Read more: https://zensical.org/docs/setup/basics/#copyright
copyright = """
Copyright © 2026 Sam Foreman
"""

nav = [
    { "🍋 ezpz" = "index.md" },

    { "📖 Guide" = [
        { "🏃‍♂️ Quick Start" = "quickstart.md" },
        { "🧑‍🍳 Recipes" = "recipes.md" },
        { "📖 Reference" = "reference.md" },
        { "📊 Metric Tracking" = "history.md" },
        { "⚙️ Configuration" = "configuration.md" },
        { "🏗️ Architecture" = "architecture.md" },
        { "🔧 Troubleshooting" = "troubleshooting.md" },
        { "❓ FAQ" = "notes/faq.md" },
    ] },

    { "🧰 CLI" = [
        "cli/index.md",
        { "🚀 <code>ezpz launch</code>" = "cli/launch/index.md" },
        { "💯 <code>ezpz test</code>" = "cli/test.md" },
        { "🩺 <code>ezpz doctor</code>" = "cli/doctor.md" },
        { "🧪 Experimental" = [
            { "✍️ <code>ezpz generate</code>" = "cli/generate.md" },
            { "🖥️ <code>ezpz generate_tui</code>" = "cli/generate-tui.md" },
        ] },
        { "📘 References" = [
            { "🗓️ PBS" = "notes/pbs.md" },
            { "📄 Report" = "cli/test-report.md" },
        ] },
    ] },

    { "📝 Examples" = [
        "examples/index.md",
        { "<code>ezpz.examples.test</code>" = "examples/test.md" },
        { "<code>ezpz.examples.fsdp</code>" = "examples/fsdp.md" },
        { "<code>ezpz.examples.vit</code>" = "examples/vit.md" },
        { "<code>ezpz.examples.diffusion</code>" = "examples/diffusion.md" },
        { "<code>ezpz.examples.fsdp_tp</code>" = "examples/fsdp-tp.md" },
        { "<code>ezpz.examples.hf</code>" = "examples/hf.md" },
        { "<code>ezpz.examples.hf_trainer</code>" = [
            "examples/hf-trainer/index.md",
            { "🤗 HF Trainer Comparison" = "examples/hf-trainer/comparison.md" },
        ] },
        { "Minimal (Synthetic) [deprecated]" = "examples/minimal.md" },
    ] },
    # ] },

    { "🐍 Python API" = [
        "python/index.md",
        { "<code>ezpz</code>" = [
            "python/Code-Reference/index.md",
            { "<code>ezpz</code>" = "python/Code-Reference/index.md" },
            { "<code>ezpz.configs</code>" = "python/Code-Reference/configs.md" },
            { "<code>ezpz.dist</code>" = "python/Code-Reference/dist.md" },
            { "<code>ezpz.doctor</code>" = "python/Code-Reference/doctor.md" },
            { "<code>ezpz.history</code>" = "python/Code-Reference/history.md" },
            { "<code>ezpz.integrations</code>" = "python/Code-Reference/integrations.md" },
            { "<code>ezpz.jobs</code>" = "python/Code-Reference/jobs.md" },
            { "<code>ezpz.launch</code>" = "python/Code-Reference/launch.md" },
            { "<code>ezpz.lazy</code>" = "python/Code-Reference/lazy.md" },
            { "<code>ezpz.model</code>" = "python/Code-Reference/model.md" },
            { "<code>ezpz.pbs</code>" = "python/Code-Reference/pbs.md" },
            { "<code>ezpz.plot</code>" = "python/Code-Reference/plot.md" },
            { "<code>ezpz.profile</code>" = "python/Code-Reference/profile.md" },
            { "<code>ezpz.slurm</code>" = "python/Code-Reference/slurm.md" },
            { "<code>ezpz.test</code>" = "python/Code-Reference/test.md" },
            { "<code>ezpz.test_dist</code>" = "python/Code-Reference/test_dist.md" },
            { "<code>ezpz.tplot</code>" = "python/Code-Reference/tplot.md" },

            { "<code>ezpz.cli</code>" = [
                "python/Code-Reference/cli/index.md",
                { "<code>ezpz.cli.flags</code>" = "python/Code-Reference/cli/flags.md" },
                { "<code>ezpz.cli.launch_cmd</code>" = "python/Code-Reference/cli/launch_cmd.md" },
                { "<code>ezpz.cli.test_cmd</code>" = "python/Code-Reference/cli/test_cmd.md" },
            ] },

            { "<code>ezpz.data</code>" = [
                "python/Code-Reference/data/index.md",
                { "<code>ezpz.data.distributed</code>" = "python/Code-Reference/data/distributed.md" },
                { "<code>ezpz.data.hf</code>" = "python/Code-Reference/data/hf.md" },
                { "<code>ezpz.data.llama</code>" = "python/Code-Reference/data/llama.md" },
                { "<code>ezpz.data.text</code>" = "python/Code-Reference/data/text.md" },
                { "<code>ezpz.data.vision</code>" = "python/Code-Reference/data/vision.md" },
                { "<code>ezpz.data.utils</code>" = "python/Code-Reference/data/utils.md" },
            ] },

            { "<code>ezpz.examples</code>" = [
                "python/Code-Reference/examples/index.md",
                { "<code>ezpz.examples.diffusion</code>" = "python/Code-Reference/examples/diffusion.md" },
                { "<code>ezpz.examples.fsdp</code>" = "python/Code-Reference/examples/fsdp.md" },
                { "<code>ezpz.examples.fsdp_tp</code>" = "python/Code-Reference/examples/fsdp_tp.md" },
                { "<code>ezpz.examples.generate</code>" = "python/Code-Reference/examples/generate.md" },
                { "<code>ezpz.examples.generate_tui</code>" = "python/Code-Reference/examples/generate_tui.md" },
                { "<code>ezpz.examples.hf</code>" = "python/Code-Reference/examples/hf.md" },
                { "<code>ezpz.examples.hf_trainer</code>" = "python/Code-Reference/examples/hf_trainer.md" },
                { "<code>ezpz.examples.minimal</code>" = "python/Code-Reference/examples/minimal.md" },
                { "<code>ezpz.examples.vit</code>" = "python/Code-Reference/examples/vit.md" },
            ] },

            { "<code>ezpz.log</code>" = [
                "python/Code-Reference/log/index.md",
                { "<code>ezpz.log.config</code>" = "python/Code-Reference/log/config.md" },
                { "<code>ezpz.log.console</code>" = "python/Code-Reference/log/console.md" },
                { "<code>ezpz.log.__main__</code>" = "python/Code-Reference/log/__main__.md" },
                { "<code>ezpz.log.dataframe</code>" = "python/Code-Reference/log/dataframe.md" },
                { "<code>ezpz.log.handler</code>" = "python/Code-Reference/log/handler.md" },
                { "<code>ezpz.log.style</code>" = "python/Code-Reference/log/style.md" },
                { "<code>ezpz.log.test</code>" = "python/Code-Reference/log/test.md" },
            ] },

            { "<code>ezpz.models</code>" = [
                "python/Code-Reference/models/index.md",
                { "<code>ezpz.models.attention</code>" = "python/Code-Reference/models/attention.md" },
                { "<code>ezpz.models.llama</code>" = "python/Code-Reference/models/llama.md" },
                { "<code>ezpz.models.minimal</code>" = "python/Code-Reference/models/minimal.md" },
                { "<code>ezpz.models.llama3.model</code>" = "python/Code-Reference/models/llama3/model.md" },
                { "<code>ezpz.models.vit.attention</code>" = "python/Code-Reference/models/vit/attention.md" },
            ] },

            { "<code>ezpz.tp</code>" = [
                "python/Code-Reference/tp/index.md",
                { "<code>ezpz.tp.layers</code>" = "python/Code-Reference/tp/layers.md" },
                { "<code>ezpz.tp.mappings</code>" = "python/Code-Reference/tp/mappings.md" },
                { "<code>ezpz.tp.utils</code>" = "python/Code-Reference/tp/utils.md" },
            ] },

            { "<code>ezpz.utils</code>" = [
                "python/Code-Reference/utils.md",
                { "<code>ezpz.utils.tar_env</code>" = "python/Code-Reference/utils/tar_env.md" },
                { "<code>ezpz.utils.yeet_env</code>" = "python/Code-Reference/utils/yeet_env.md" },
            ] },
        ] },
    ] },

    { "📓 Notes" = [
        "notes/index.md",
        { "🖍️ Overview" = "notes/diagrams.md" },
        { "🏔️ Perlmutter" = "notes/perlmutter.md" },

        { "🧤 Hands-On Slides" = "notes/slides-2025-05-07.md" },

        { "🕸️ Parallelism" = "notes/parallelism.md" },
        { "🏖️ Shell Environment" = "notes/shell-environment.md" },
        { "🤖 Systems" = "notes/systems.md" },
        { "📦 Yeet Environment" = "notes/yeet-env.md" },

        # { "WIP" = [
        #     { "🧪 Tests" = [
        #         { "🧪 Tests" = "python/tests/index.md" },
        #         { "configs" = "python/tests/test-configs.md" },
        #         { "configs-improved" = "python/tests/test-configs-improved.md" },
        #         { "comprehensive harness" = "python/tests/comprehensive-test.md" },
        #         { "dist" = "python/tests/test-dist.md" },
        #         { "ezpz" = "python/tests/test-ezpz.md" },
        #         { "jobs" = "python/tests/test-jobs.md" },
        #         { "launch" = "python/tests/test-launch.md" },
        #         { "lazy" = "python/tests/test-lazy.md" },
        #         { "logging" = "python/tests/test-log.md" },
        #         { "modules" = "python/tests/test-modules-directly.md" },
        #         { "property based" = "python/tests/test-property-based.md" },
        #         { "profile" = "python/tests/test-profile.md" },
        #         { "history" = "python/tests/test-history.md" },
        #         { "simple" = "python/tests/simple-test.md" },
        #         { "simple-runner" = "python/tests/simple-test-runner.md" },
        #         { "simple-ezpz" = "python/tests/test-simple-ezpz.md" },
        #         { "tp" = "python/tests/test-tp.md" },
        #         { "tplot" = "python/tests/test-tplot.md" },
        #         { "utils" = "python/tests/test-utils.md" },
        #         { "utils-improved" = "python/tests/test-utils-improved.md" },
        #     ] },
        # ] },
    ] },
]

# { "<code>ezpz.examples.cifar.train_ds</code>" = "python/Code-Reference/examples/cifar/train_ds.md" },
# { "<code>ezpz.examples.hf_trainer_alt</code>" = "python/Code-Reference/examples/hf_trainer_alt.md" },
# { "<code>ezpz.examples.vit_timm</code>" = "python/Code-Reference/examples/vit_timm.md" },
# { "<code>ezpz.examples.deepspeed tp</code>" = [
#   { "<code>train</code>"              = "python/Code-Reference/examples/deepspeed/tp/train.md" },
#   { "<code>train_batch_length</code>" = "python/Code-Reference/examples/deepspeed/tp/train_batch_length.md" },
#   { "<code>utils</code>"              = "python/Code-Reference/examples/deepspeed/tp/utils.md" },
# ] },
# Zensical supports both implicit navigation and explicitly defined navigation.
# If you decide not to define a navigation here then Zensical will simply
# derive the navigation structure from the directory structure of your
# "docs_dir". The definition below demonstrates how a navigation structure
# can be defined using TOML syntax.
#
# Read more: https://zensical.org/docs/setup/navigation/
# nav = [
#   { "Get started" = "index.md" },
#   { "Markdown in 5min" = "markdown.md" },
# ]
# With the "extra_css" option you can add your own CSS styling to customize
# your Zensical project according to your needs. You can add any number of
# CSS files.
#
# The path provided should be relative to the "docs_dir".
#
# Read more: https://zensical.org/docs/customization/#additional-css
#
#extra_css = ["stylesheets/extra.css"]
#
extra_css = [
    "https://unpkg.com/katex@0/dist/katex.min.css",
    "stylesheets/oklch.min.css",
    "stylesheets/one-light.css",
    "stylesheets/atom-one-dark-reasonable.css",
    "stylesheets/theme.css",
    "overrides/fonts.css",
    "https://iosevka-webfonts.github.io/iosevka/Iosevka.css",
    "https://iosevka-webfonts.github.io/iosevka-fixed/iosevka-fixed.css",
    # "stylesheets/custom.css",
    # "https://drafts.csswg.org/css-color-4/#lab-colors",
    # "https://drafts.csswg.org/css-color-4/#resolving-lab-lch-values",
    # "https://drafts.csswg.org/css-color-4/#resolving-oklab-oklch-values",
    # "https://drafts.csswg.org/css-color-4/#serializing-lab-lch",
    # "https://drafts.csswg.org/css-color-4/#serializing-oklab-oklch",
]


# With the `extra_javascript` option you can add your own JavaScript to your
# project to customize the behavior according to your needs.
#
# The path provided should be relative to the "docs_dir".
#
# Read more: https://zensical.org/docs/customization/#additional-javascript
#extra_javascript = ["javascripts/extra.js"]
extra_javascript = [
    "javascripts/katex.js",
    "https://unpkg.com/katex@0/dist/katex.min.js",
    "https://unpkg.com/katex@0/dist/contrib/auto-render.min.js",
    "https://unpkg.com/mermaid@11.6.0/dist/mermaid.min.js",
    "javascripts/mermaid-init.js",
]


# ----------------------------------------------------------------------------
# Section for configuring theme options
# ----------------------------------------------------------------------------
[project.theme]


# change this to "classic" to use the traditional Material for MkDocs look.
#variant = "classic"

# Zensical allows you to override specific blocks, partials, or whole
# templates as well as to define your own templates. To do this, uncomment
# the custom_dir setting below and set it to a directory in which you
# keep your template overrides.
#
# Read more:
# - https://zensical.org/docs/customization/#extending-the-theme
#
custom_dir = "docs/overrides"

# With the "favicon" option you can set your own image to use as the icon
# browsers will use in the browser title bar or tab bar. The path provided
# must be relative to the "docs_dir".
#
# Read more:
# - https://zensical.org/docs/setup/logo-and-icons/#favicon
# - https://developer.mozilla.org/en-US/docs/Glossary/Favicon
#
favicon = "assets/lemon.png"

# Zensical supports more than 60 different languages. This means that the
# labels and tooltips that Zensical's templates produce are translated.
# The "language" option allows you to set the language used. This language
# is also indicated in the HTML head element to help with accessibility
# and guide search engines and translation tools.
#
# The default language is "en" (English). It is possible to create
# sites with multiple languages and configure a language selector. See
# the documentation for details.
#
# Read more:
# - https://zensical.org/docs/setup/language/
#
language = "en"

# Zensical provides a number of feature toggles that change the behavior
# of the documentation site.
features = [
    # Zensical includes an announcement bar. This feature allows users to
    # dismiss it then they have read the announcement.
    # https://zensical.org/docs/setup/header/#announcement-bar
    "announce.dismiss",

    # If you have a repository configured and turn on this feature, Zensical
    # will generate an edit button for the page. This works for common
    # repository hosting services.
    # https://zensical.org/docs/setup/repository/#code-actions
    "content.action.edit",

    # If you have a repository configured and turn on this feature, Zensical
    # will generate a button that allows the user to view the Markdown
    # code for the current page.
    # https://zensical.org/docs/setup/repository/#code-actions
    "content.action.view",

    # Code annotations allow you to add an icon with a tooltip to your
    # code blocks to provide explanations at crucial points.
    # https://zensical.org/docs/authoring/code-blocks/#code-annotations
    "content.code.annotate",

    # This feature turns on a button in code blocks that allow users to
    # copy the content to their clipboard without first selecting it.
    # https://zensical.org/docs/authoring/code-blocks/#code-copy-button
    "content.code.copy",

    # Code blocks can include a button to allow for the selection of line
    # ranges by the user.
    # https://zensical.org/docs/authoring/code-blocks/#code-selection-button
    "content.code.select",

    # Zensical can render footnotes as inline tooltips, so the user can read
    # the footnote without leaving the context of the document.
    # https://zensical.org/docs/authoring/footnotes/#footnote-tooltips
    "content.footnote.tooltips",

    # If you have many content tabs that have the same titles (e.g., "Python",
    # "JavaScript", "Cobol"), this feature causes all of them to switch to
    # at the same time when the user chooses their language in one.
    # https://zensical.org/docs/authoring/content-tabs/#linked-content-tabs
    "content.tabs.link",

    # TODO: not sure I understand this one? Is there a demo of this in the docs?
    # https://zensical.org/docs/authoring/tooltips/#improved-tooltips
    "content.tooltips",

    # With this feature enabled, Zensical will automatically hide parts
    # of the header when the user scrolls past a certain point.
    # https://zensical.org/docs/setup/header/#automatic-hiding
    "header.autohide",

    # Turn on this feature to expand all collapsible sections in the
    # navigation sidebar by default.
    # https://zensical.org/docs/setup/navigation/#navigation-expansion
    # "navigation.expand",

    # This feature turns on navigation elements in the footer that allow the
    # user to navigate to a next or previous page.
    # https://zensical.org/docs/setup/footer/#navigation
    "navigation.footer",

    # When section index pages are enabled, documents can be directly attached
    # to sections, which is particularly useful for providing overview pages.
    # https://zensical.org/docs/setup/navigation/#section-index-pages
    "navigation.indexes",

    # When instant navigation is enabled, clicks on all internal links will be
    # intercepted and dispatched via XHR without fully reloading the page.
    # https://zensical.org/docs/setup/navigation/#instant-navigation
    "navigation.instant",

    # With instant prefetching, your site will start to fetch a page once the
    # user hovers over a link. This will reduce the perceived loading time
    # for the user.
    # https://zensical.org/docs/setup/navigation/#instant-prefetching
    "navigation.instant.prefetch",

    # In order to provide a better user experience on slow connections when
    # using instant navigation, a progress indicator can be enabled.
    # https://zensical.org/docs/setup/navigation/#progress-indicator
    "navigation.instant.progress",

    # When navigation paths are activated, a breadcrumb navigation is rendered
    # above the title of each page
    # https://zensical.org/docs/setup/navigation/#navigation-path
    "navigation.path",

    # When pruning is enabled, only the visible navigation items are included
    # in the rendered HTML, reducing the size of the built site by 33% or more.
    # https://zensical.org/docs/setup/navigation/#navigation-pruning
    "navigation.prune",

    # When sections are enabled, top-level sections are rendered as groups in
    # the sidebar for viewports above 1220px, but remain as-is on mobile.
    # https://zensical.org/docs/setup/navigation/#navigation-sections
    "navigation.sections",

    # When tabs are enabled, top-level sections are rendered in a menu layer
    # below the header for viewports above 1220px, but remain as-is on mobile.
    # https://zensical.org/docs/setup/navigation/#navigation-tabs
    "navigation.tabs",

    # When sticky tabs are enabled, navigation tabs will lock below the header
    # and always remain visible when scrolling down.
    # https://zensical.org/docs/setup/navigation/#sticky-navigation-tabs
    # "navigation.tabs.sticky",

    # A back-to-top button can be shown when the user, after scrolling down,
    # starts to scroll up again.
    # https://zensical.org/docs/setup/navigation/#back-to-top-button
    "navigation.top",

    # When anchor tracking is enabled, the URL in the address bar is
    # automatically updated with the active anchor as highlighted in the table
    # of contents.
    # https://zensical.org/docs/setup/navigation/#anchor-tracking
    "navigation.tracking",

    # When search highlighting is enabled and a user clicks on a search result,
    # Zensical will highlight all occurrences after following the link.
    # https://zensical.org/docs/setup/search/#search-highlighting
    "search.highlight",

    # When anchor following for the table of contents is enabled, the sidebar
    # is automatically scrolled so that the active anchor is always visible.
    # https://zensical.org/docs/setup/navigation/#anchor-following
    "toc.follow",

    # When navigation integration for the table of contents is enabled, it is
    # always rendered as part of the navigation sidebar on the left.
    # https://zensical.org/docs/setup/navigation/#navigation-integration
    "toc.integrate",
]

# ----------------------------------------------------------------------------
# In the "palette" subsection you can configure options for the color scheme.
# You can configure different color # schemes, e.g., to turn on dark mode,
# that the user can switch between. Each color scheme can be further
# customized.
#
# Read more:
# - https://zensical.org/docs/setup/colors/
# ----------------------------------------------------------------------------
# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
# primary = "blue"
# accent = "blue"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
# [data-md-color-primary="indigo"]
primary = "yellow"
accent = "yellow"
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"

# ----------------------------------------------------------------------------
# In the "font" subsection you can configure the fonts used. By default, fonts
# are loaded from Google Fonts, giving you a wide range of choices from a set
# of suitably licensed fonts. There are options for a normal text font and for
# a monospaced font used in code blocks.
# ----------------------------------------------------------------------------
[project.theme.font]
heading = "Iosevka Web"
text = "Iosevka Web"
code = "Iosevka Fixed Web"

# ----------------------------------------------------------------------------
# You can configure your own logo to be shown in the header using the "logo"
# option in the "icons" subsection. The logo can be a path to a file in your
# "docs_dir" or it can be a path to an icon.
#
# Likewise, you can customize the logo used for the repository section of the
# header. Zensical derives the default logo for this from the repository URL.
# See below...
#
# There are other icons you can customize. See the documentation for details.
#
# Read more:
# - https://zensical.org/docs/setup/logo-and-icons
# - https://zensical.org/docs/authoring/icons-emojis/#search
# ----------------------------------------------------------------------------
[project.theme.icon]
logo = "custom/lemon"
repo = "custom/github"

# [project.theme.icon.admonition]
# note = "fontawesome/solid/note-sticky"
# abstract = "fontawesome/solid/book"
# info = "fontawesome/solid/circle-info"
# tip = "fontawesome/solid/bullhorn"
# success = "fontawesome/solid/check"
# question = "fontawesome/solid/circle-question"
# warning = "fontawesome/solid/triangle-exclamation"
# failure = "fontawesome/solid/bomb"
# danger = "fontawesome/solid/skull"
# bug = "fontawesome/solid/robot"
# example = "fontawesome/solid/flask"
# quote = "fontawesome/solid/quote-left"

# [project.theme.icon.admonition]
# note = "octicons/tag-16"
# abstract = "octicons/checklist-16"
# info = "octicons/info-16"
# # tip = "octicons/squirrel-16"
# tip = "octicons/light-bulb"
# success = "octicons/check-16"
# question = "octicons/question-16"
# warning = "octicons/alert-16"
# failure = "octicons/fire"
# danger = "octicons/zap-16"
# bug = "octicons/bug-16"
# example = "octicons/beaker-16"
# quote = "octicons/quote-16"

# ----------------------------------------------------------------------------
# The "extra" section contains miscellaneous settings.
# ----------------------------------------------------------------------------
#[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/saforem2/ezpz"


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

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
inherited_members = true
show_source = true


# [project.markdown_extensions.zensical.extensions.preview]
# configurations = [
# { targets.include = [
#         ""
#     ]}
# ]

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

[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.pymdownx.blocks.caption]
[project.markdown_extensions.pymdownx.highlight]
linenums = true
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
# auto_title = true
linenums_style = "pymdownx-inline"
[project.markdown_extensions.pymdownx.snippets]
base_path = ["includes", "."]

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"    # (1)!
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.abbr]
[project.markdown_extensions.def_list]
[project.markdown_extensions.toc]
permalink = "⚓︎"
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
smart_enable = "all"
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]