Files
doc-forge/tests/renderers/mkdocs/test_mkdocs_structure.py

25 lines
651 B
Python

from pathlib import Path
from docforge import MkDocsRenderer
from docforge.models 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)
renderer.generate_readme(
project,
out_dir,
module_is_source=True,
)
assert (out_dir / "testpkg" / "index.md").exists()
assert (out_dir / "testpkg" / "sub.md").exists()
assert (tmp_path / "README.md").exists()