feat(docs): expand functions/ and completions/ in the Starlight home tree

List every file in functions/ and completions/ inline under the home
page's file tree instead of a one-line summary. The listing is read
live off disk during --site generation, so it never needs manual
upkeep, and only affects the Starlight build — the plain-text
manual/man page (--concat) still renders the compact summary.
This commit is contained in:
2026-08-25 01:07:07 -04:00
parent 38924d5c3c
commit 82d78d19f5
2 changed files with 66 additions and 0 deletions
+55
View File
@@ -805,6 +805,61 @@ def test_as_file_tree_accepts_deeper_trees():
), f"unexpected file tree output:\n{out}"
def test_as_file_tree_expands_functions_and_completions():
"""The functions/ and completions/ branches list real directory contents."""
import build_manual
with tempfile.TemporaryDirectory() as d:
root = Path(d)
functions_dir = root / "functions"
functions_dir.mkdir()
(functions_dir / "zeta.fish").write_text("")
(functions_dir / "Alpha.fish").write_text("")
completions_dir = root / "completions"
completions_dir.mkdir()
(completions_dir / "bd.fish").write_text("")
original = dict(build_manual.EXPANDABLE_TREE_DIRS)
build_manual.EXPANDABLE_TREE_DIRS["functions/"] = functions_dir
build_manual.EXPANDABLE_TREE_DIRS["completions/"] = completions_dir
try:
para = [
"~/.config/fish/",
"├── functions/ Custom functions, one per file",
"└── completions/ Tab completion scripts",
]
out = build_manual._as_file_tree(para)
finally:
build_manual.EXPANDABLE_TREE_DIRS.clear()
build_manual.EXPANDABLE_TREE_DIRS.update(original)
assert out == (
"<FileTree>\n"
"- ~/.config/fish/\n"
" - functions/ Custom functions, one per file\n"
" - Alpha.fish\n"
" - zeta.fish\n"
" - completions/ Tab completion scripts\n"
" - bd.fish\n"
"</FileTree>"
), f"unexpected file tree output:\n{out}"
def test_as_file_tree_leaves_unrelated_branches_unexpanded():
"""Only the mapped directory names get expanded; everything else is untouched."""
import build_manual
para = [
"$__fish_user_dots_path/",
"├── secrets.fish API keys, tokens, passwords, personal identifiers",
"└── local.fish Machine-specific paths, env vars, and sourcing secrets",
]
out = build_manual._as_file_tree(para)
assert "secrets.fish" in out and "local.fish" in out
assert len(out.splitlines()) == 5, f"unexpected expansion of unrelated branches:\n{out}"
def test_customization_notes_render_as_aside():
"""The real 07-customization NOTE paragraph converts to one intact <Aside>."""
import build_manual