dc-up/zensical.toml at main · denisecase/dc-up · 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
# ============================================================
# zensical.toml (ALL-PY-SRC-REPOS)
# ============================================================
# Updated: 2026-06-27
#
# REQ: Python src/ repositories SHOULD provide documentation configuration.
# WHY: Centralizes project documentation configuration.

[project]
site_name = "Docs" # CUSTOM: Set the name that appears in the browser tab.
site_url = "https://denisecase.github.io/dc-up/"
repo_url = "https://github.com/denisecase/dc-up"
repo_name = "dc-up"
site_description = "Project Documentation" # CUSTOM: Set the description.
docs_dir = "docs" # source directory for documentation markdown files
site_dir = "site" # output directory for generated site (ignored by Git; not in repo)
edit_uri = "edit/main/docs/" # "Edit this page" links (GitHub)

[project.extra]
# WHY: Social links provide easy access to project repositories and profiles.
social = [
    {icon = "fontawesome/brands/github", link = "https://github.com/denisecase/dc-up" },
]

# ------------------------------------------------------------
# Plugins
# ------------------------------------------------------------

[project.plugins.search]
lang = "en" # WHY: Search plugin provides instant search functionality for documentation.

[project.plugins.mkdocstrings.handlers.python]
paths = ["src"] # WHY: MkDocstrings auto-generates documentation from code; this points it to the source code directory.

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google" # WHY: Google style docstrings are widely used and supported by many tools.
show_source = true # WHY: Showing source code can help users understand implementation details.
show_root_heading = true
show_root_toc_entry = true
show_signature_annotations = true
separate_signature = true

[project.theme]
# SEE: https://zensical.org/docs/setup/navigation/#instant-navigation-zensicaltoml
features = [
    "navigation.tracking", # WHY: Track documentation navigation behavior.
    "navigation.expand", # WHY: Expandable navigation helps users focus on relevant sections.
    "navigation.path", # WHY: Path navigation helps users understand location.
    "navigation.prune", # WHY: Pruning simplifies navigation.
    "navigation.indexes", # WHY: Indexes provide an overview of documentation structure.
    "toc.follow", # WHY: Keep table of contents in sync with the current page.
    "toc.integrate", # WHY: Integrate table of contents into navigation.
    "navigation.top", # WHY: Add a back-to-top button.
]

# ------------------------------------------------------------
# Navigation
# ------------------------------------------------------------
# Use folder-based navigation rather than explicit navigation.