feat: add wiki build kind with file-structure-derived navigation

- add build_wiki_nav deriving MkDocs nav from docs/wiki file structure
  (index.md -> Home, numeric prefixes stripped and title-cased, nested
  dirs become groups, natural ordering)
- add --wiki / --wiki-dir to build; wiki-only builds need no --module
- merge wiki nav before generated lib/api nav; wiki Home replaces the
  nav spec Home entry
- add mkdocs.wiki.yml template fragment and nav/cli tests
- dogfood doc-forge's own docs/wiki and regenerate site output
This commit is contained in:
2026-09-11 23:38:23 +05:30
parent bacf17b930
commit 8c6c46caf2
44 changed files with 798 additions and 17 deletions

View File

@@ -0,0 +1,137 @@
from pathlib import Path
from docforge.cli.main import cli
def test_wiki_only_build_requires_no_module(
cli_runner,
mock_mkdocs_build,
mock_mkdocs_load_config,
):
with cli_runner.isolated_filesystem():
cwd = Path.cwd()
wiki = cwd / "docs" / "wiki"
wiki.mkdir(parents=True)
(wiki / "index.md").write_text("# Home", encoding="utf-8")
(wiki / "01_overview.md").write_text("# Overview", encoding="utf-8")
result = cli_runner.invoke(
cli,
[
"build",
"--wiki",
"--site-name",
"Wiki Site",
"--mkdocs-yml",
"mkdocs.yml",
],
)
assert result.exit_code == 0, result.output
assert mock_mkdocs_build() is True
assert (cwd / "mkdocs.yml").exists()
content = (cwd / "mkdocs.yml").read_text(encoding="utf-8")
assert "docs_dir: docs" in content
assert "Home: wiki/index.md" in content
assert "Overview: wiki/01_overview.md" in content
def test_wiki_combined_with_mkdocs_keeps_lib_nav(
cli_runner,
mock_mkdocs_build,
mock_mkdocs_load_config,
):
with cli_runner.isolated_filesystem():
cwd = Path.cwd()
pkg = cwd / "testpkg"
pkg.mkdir()
(pkg / "__init__.py").write_text("")
(pkg / "mod.py").write_text("def f(): ...\n")
nav_file = cwd / "docforge.nav.yml"
nav_file.write_text(
"home: lib/testpkg/index.md\ngroups: {}\n",
encoding="utf-8",
)
wiki = cwd / "docs" / "wiki"
wiki.mkdir(parents=True)
(wiki / "index.md").write_text("# Home", encoding="utf-8")
result = cli_runner.invoke(
cli,
[
"build",
"--mkdocs",
"--wiki",
"--module",
"testpkg",
"--site-name",
"Combined Site",
"--mkdocs-yml",
"mkdocs.yml",
],
)
assert result.exit_code == 0, result.output
assert mock_mkdocs_build() is True
assert (cwd / "docs" / "lib" / "testpkg" / "mod.md").exists()
content = (cwd / "mkdocs.yml").read_text(encoding="utf-8")
assert "docs_dir: docs" in content
assert "Home: wiki/index.md" in content
# Wiki home replaces the lib home entry
assert "Home: lib/testpkg/index.md" not in content
def test_wiki_without_module_flag_ok(
cli_runner,
mock_mkdocs_build,
mock_mkdocs_load_config,
):
with cli_runner.isolated_filesystem():
cwd = Path.cwd()
wiki = cwd / "docs" / "wiki"
wiki.mkdir(parents=True)
(wiki / "index.md").write_text("# Home", encoding="utf-8")
result = cli_runner.invoke(
cli,
["build", "--wiki", "--site-name", "S"],
)
assert result.exit_code == 0, result.output
assert mock_mkdocs_build() is True
def test_missing_wiki_dir_errors(cli_runner, mock_mkdocs_build):
with cli_runner.isolated_filesystem():
cwd = Path.cwd()
(cwd / "docs").mkdir()
result = cli_runner.invoke(
cli,
[
"build",
"--wiki",
"--site-name",
"S",
"--wiki-dir",
"docs/wiki",
"--mkdocs-yml",
"mkdocs.yml",
],
)
assert result.exit_code != 0
assert "Wiki dir not found" in result.output
def test_no_flag_raises_usage_error(cli_runner):
result = cli_runner.invoke(cli, ["build"])
assert result.exit_code != 0
assert "--mcp, --mkdocs, --wiki, or --api" in result.output

106
tests/nav/test_wiki.py Normal file
View File

@@ -0,0 +1,106 @@
from pathlib import Path
import pytest
from docforge.nav import build_wiki_nav
def _write_wiki(root: Path, files: list[str]) -> None:
for rel in files:
full = root / rel
full.parent.mkdir(parents=True, exist_ok=True)
full.write_text(f"# {rel}", encoding="utf-8")
def test_missing_wiki_dir_raises(tmp_path: Path):
with pytest.raises(FileNotFoundError):
build_wiki_nav(tmp_path / "nope")
def test_empty_wiki_dir_returns_empty(tmp_path: Path):
wiki = tmp_path / "wiki"
wiki.mkdir()
assert build_wiki_nav(wiki) == []
def test_index_becomes_home(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(wiki, ["index.md", "01_overview.md"])
nav = build_wiki_nav(wiki)
assert nav[0] == {"Home": "wiki/index.md"}
assert {"Overview": "wiki/01_overview.md"} in nav
def test_number_prefix_stripped_and_prettified(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(wiki, ["01_basic_crud.md", "02_custom_repo.md", "10_transactions.md"])
nav = build_wiki_nav(wiki)
labels = [list(entry)[0] for entry in nav]
assert labels == ["Basic Crud", "Custom Repo", "Transactions"]
def test_directory_becomes_nested_group(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(
wiki,
[
"index.md",
"03_use_cases/01_basic_crud.md",
"03_use_cases/02_custom_repo.md",
],
)
nav = build_wiki_nav(wiki)
assert {"Home": "wiki/index.md"} in nav
assert {
"Use Cases": [
{"Basic Crud": "wiki/03_use_cases/01_basic_crud.md"},
{"Custom Repo": "wiki/03_use_cases/02_custom_repo.md"},
]
} in nav
def test_nested_index_is_section_root(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(
wiki,
[
"guide/index.md",
"guide/01_setup.md",
],
)
nav = build_wiki_nav(wiki)
assert {
"Guide": [
{"Guide": "wiki/guide/index.md"},
{"Setup": "wiki/guide/01_setup.md"},
]
} in nav
def test_hidden_entries_ignored(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(wiki, ["index.md", ".draft.md"])
(wiki / ".hidden").mkdir()
nav = build_wiki_nav(wiki)
assert nav == [{"Home": "wiki/index.md"}]
def test_natural_order_for_zero_padded_prefixes(tmp_path: Path):
wiki = tmp_path / "docs" / "wiki"
_write_wiki(wiki, ["02_b.md", "10_j.md", "01_a.md"])
nav = build_wiki_nav(wiki)
labels = [list(entry)[0] for entry in nav if list(entry)[0] in {"A", "B", "J"}]
assert labels == ["A", "B", "J"]