zensical.toml

# Copyright 2025 ETH Zurich and University of Bologna.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

[project]

site_name = "FlooNoC"
site_description = "Documentation for the FlooNoC IPs and FlooGen generator."
site_author = "Tim Fischer"
site_url = "https://pulp-platform.github.io/FlooNoC"
repo_url = "https://github.com/pulp-platform/FlooNoC"
copyright = """
Copyright 2025 ETH Zurich and University of Bologna.
"""
docs_dir = "docs"

nav = [
    {"Home" = [
        "index.md",
    ]},
    {"FlooNoC" = [
        {"Overview" = "floonoc/overview.md"},
        {"Getting Started" = "floonoc/getting_started.md"},
        {"IP Reference" = [
            {"Flits" = "floonoc/flits.md"},
            {"Channels & Links" = "floonoc/links.md"},
            {"Routing Algorithms" = "floonoc/route_algos.md"},
            {"Network Interfaces" = "floonoc/chimneys.md"},
            {"Router" = "floonoc/routers.md"}
        ]},
    ]},
    {"FlooGen" = [
        {"Overview" = "floogen/overview.md"},
        {"Installation" = "floogen/installation.md"},
        {"Getting Started" = [
            {"CLI Usage" = "floogen/cli.md"},
            {"Minimal Example" = "floogen/minimal_example.md"}, # Split from overview.md
        ]},
        {"Configuration Guide" = [
            {"Global Settings" = [
                {"System Configuration" = "floogen/network_types.md"},
                {"Routing" = "floogen/routing.md"},
            ]},
            {"Network Components" = [
                {"Protocols" = "floogen/protocols.md"},
                {"Endpoints" = "floogen/endpoints.md"},
                {"Routers" = "floogen/routers.md"},
            ]},
            {"Topology & Connections" = "floogen/connections.md"},
        ]},
        {"Examples" = [
            {"Simple" = "floogen/examples/simple.md"},
            {"Complex" = "floogen/examples/complex.md"},
        ]},
        {"Reference" = [
            {"Routing Model" = "floogen/reference/routing.md"},
            {"Graph" = "floogen/reference/graph.md"},
            {"Endpoint" = "floogen/reference/endpoint.md"},
            {"Router" = "floogen/reference/router.md"},
            {"Connection" = "floogen/reference/connection.md"},
            {"Link" = "floogen/reference/link.md"},
            {"Network Interface" = "floogen/reference/network_interface.md"},
            {"Protocol" = "floogen/reference/protocol.md"},
            {"Utils" = "floogen/reference/utils.md"},
        ]},
        {"Others" = [
            {"Known Issues" = "floogen/known_issues.md"},
            {"Changelog" = "changelog.md"}
        ]}
    ]},
    {"Integration" = [
        "integration/integration.md"
    ]},
    {"Changelog" = "CHANGELOG.md"}
]


extra_css = ["stylesheets/extra.css"]
# extra_javascript = [
#     "javascripts/mathjax.js",
#     "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"
# ]

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

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

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


[project.theme]

# 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 = "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 = "img/floo_noc_favicon_logo.png"

language = "en"

# Zensical provides a number of feature toggles that change the behavior
# of the documentation site.
features = [
    # 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",

    # 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 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",
    "navigation.tabs.sticky",

    # 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 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 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",

    # 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",

    # 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",

    # 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",

    # 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",
]

logo = "img/floo_noc_favicon_logo.png"
icon.repo = "fontawesome/brands/github"

# ----------------------------------------------------------------------------
# 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/
# ----------------------------------------------------------------------------
[[project.theme.palette]]
scheme = "default"
primary = "custom"
accent = "green"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "custom"
accent = "green"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

# ----------------------------------------------------------------------------
# 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]
#text = "Inter"
#code = "Jetbrains Mono"

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