rendered MkDocs

This commit is contained in:
2026-01-20 20:25:46 +05:30
parent 102ea4e215
commit 65eb1b9fe8
12 changed files with 182 additions and 0 deletions

View File

View File

@@ -0,0 +1,19 @@
from pathlib import Path
from docforge import MkDocsRenderer
from docforge.model import Project, Module
def test_mkdocs_file_content(tmp_path: Path):
project = Project("testpkg")
project.add_module(Module("testpkg.mod"))
out_dir = tmp_path / "docs"
renderer = MkDocsRenderer()
renderer.generate_sources(project, out_dir)
content = (out_dir / "testpkg" / "mod.md").read_text()
assert "# Mod" in content
assert "::: testpkg.mod" in content

View File

@@ -0,0 +1,20 @@
from pathlib import Path
from docforge import MkDocsRenderer
from docforge.model import Project, Module
def test_mkdocs_idempotent(tmp_path: Path):
project = Project("testpkg")
project.add_module(Module("testpkg.mod"))
out_dir = tmp_path / "docs"
renderer = MkDocsRenderer()
renderer.generate_sources(project, out_dir)
first = (out_dir / "testpkg" / "mod.md").read_text()
renderer.generate_sources(project, out_dir)
second = (out_dir / "testpkg" / "mod.md").read_text()
assert first == second

View File

@@ -0,0 +1,18 @@
from pathlib import Path
from docforge import MkDocsRenderer
from docforge.model import Project, Module
def test_mkdocs_directory_structure(tmp_path: Path):
project = Project("testpkg")
project.add_module(Module("testpkg"))
project.add_module(Module("testpkg.sub"))
out_dir = tmp_path / "docs"
renderer = MkDocsRenderer()
renderer.generate_sources(project, out_dir)
assert (out_dir / "testpkg" / "index.md").exists()
assert (out_dir / "testpkg" / "sub.md").exists()