From 9a5e356039dc268ca9feb004f0f65cb90f74da69 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Wed, 21 Jan 2026 16:04:02 +0530 Subject: [PATCH] rename mkdocs.py to mkdocs_renderer.py --- docforge/__init__.py | 2 +- docforge/__init__.pyi | 2 +- docforge/cli/main.py | 2 +- docforge/renderers/__init__.py | 2 +- docforge/renderers/__init__.pyi | 2 +- docforge/renderers/{mkdocs.py => mkdocs_renderer.py} | 0 docforge/renderers/{mkdocs.pyi => mkdocs_renderer.pyi} | 0 tests/renderers/{ => mkdocs}/test_mkdocs_content.py | 0 tests/renderers/{ => mkdocs}/test_mkdocs_idempotency.py | 0 tests/renderers/{ => mkdocs}/test_mkdocs_module_coverage.py | 2 +- tests/renderers/{ => mkdocs}/test_mkdocs_structure.py | 0 11 files changed, 6 insertions(+), 6 deletions(-) rename docforge/renderers/{mkdocs.py => mkdocs_renderer.py} (100%) rename docforge/renderers/{mkdocs.pyi => mkdocs_renderer.pyi} (100%) rename tests/renderers/{ => mkdocs}/test_mkdocs_content.py (100%) rename tests/renderers/{ => mkdocs}/test_mkdocs_idempotency.py (100%) rename tests/renderers/{ => mkdocs}/test_mkdocs_module_coverage.py (96%) rename tests/renderers/{ => mkdocs}/test_mkdocs_structure.py (100%) diff --git a/docforge/__init__.py b/docforge/__init__.py index d30c6ca..6bd3653 100644 --- a/docforge/__init__.py +++ b/docforge/__init__.py @@ -60,6 +60,6 @@ __all__ = [ "GriffeLoader", "discover_module_paths", "MkDocsRenderer", - "model", + "models", "main", ] diff --git a/docforge/__init__.pyi b/docforge/__init__.pyi index b3c7ed0..dd3697c 100644 --- a/docforge/__init__.pyi +++ b/docforge/__init__.pyi @@ -7,6 +7,6 @@ __all__ = [ "GriffeLoader", "discover_module_paths", "MkDocsRenderer", - "model", + "models", "main", ] diff --git a/docforge/cli/main.py b/docforge/cli/main.py index ce94dea..6205d3f 100644 --- a/docforge/cli/main.py +++ b/docforge/cli/main.py @@ -9,7 +9,7 @@ from typing import Sequence, Optional import click from docforge.loaders import GriffeLoader, discover_module_paths -from docforge.renderers.mkdocs import MkDocsRenderer +from docforge.renderers.mkdocs_renderer import MkDocsRenderer from docforge.cli.mkdocs import mkdocs_cmd diff --git a/docforge/renderers/__init__.py b/docforge/renderers/__init__.py index 26de409..7c2e73b 100644 --- a/docforge/renderers/__init__.py +++ b/docforge/renderers/__init__.py @@ -17,7 +17,7 @@ To add a new renderer, implement the `DocRenderer` protocol defined in `docforge.renderers.base`. """ -from .mkdocs import MkDocsRenderer +from .mkdocs_renderer import MkDocsRenderer __all__ = [ "MkDocsRenderer", diff --git a/docforge/renderers/__init__.pyi b/docforge/renderers/__init__.pyi index 732f508..dc195d3 100644 --- a/docforge/renderers/__init__.pyi +++ b/docforge/renderers/__init__.pyi @@ -1,4 +1,4 @@ -from .mkdocs import MkDocsRenderer +from .mkdocs_renderer import MkDocsRenderer __all__ = [ "MkDocsRenderer", diff --git a/docforge/renderers/mkdocs.py b/docforge/renderers/mkdocs_renderer.py similarity index 100% rename from docforge/renderers/mkdocs.py rename to docforge/renderers/mkdocs_renderer.py diff --git a/docforge/renderers/mkdocs.pyi b/docforge/renderers/mkdocs_renderer.pyi similarity index 100% rename from docforge/renderers/mkdocs.pyi rename to docforge/renderers/mkdocs_renderer.pyi diff --git a/tests/renderers/test_mkdocs_content.py b/tests/renderers/mkdocs/test_mkdocs_content.py similarity index 100% rename from tests/renderers/test_mkdocs_content.py rename to tests/renderers/mkdocs/test_mkdocs_content.py diff --git a/tests/renderers/test_mkdocs_idempotency.py b/tests/renderers/mkdocs/test_mkdocs_idempotency.py similarity index 100% rename from tests/renderers/test_mkdocs_idempotency.py rename to tests/renderers/mkdocs/test_mkdocs_idempotency.py diff --git a/tests/renderers/test_mkdocs_module_coverage.py b/tests/renderers/mkdocs/test_mkdocs_module_coverage.py similarity index 96% rename from tests/renderers/test_mkdocs_module_coverage.py rename to tests/renderers/mkdocs/test_mkdocs_module_coverage.py index 58c750c..ba837c7 100644 --- a/tests/renderers/test_mkdocs_module_coverage.py +++ b/tests/renderers/mkdocs/test_mkdocs_module_coverage.py @@ -1,7 +1,7 @@ from pathlib import Path from docforge.loaders import GriffeLoader, discover_module_paths -from docforge.renderers.mkdocs import MkDocsRenderer +from docforge.renderers.mkdocs_renderer import MkDocsRenderer def test_mkdocs_emits_all_modules(tmp_path: Path) -> None: diff --git a/tests/renderers/test_mkdocs_structure.py b/tests/renderers/mkdocs/test_mkdocs_structure.py similarity index 100% rename from tests/renderers/test_mkdocs_structure.py rename to tests/renderers/mkdocs/test_mkdocs_structure.py