refactor: Use public/internal API layout

Author: pawamoy

README.md

@@ -77,4 +77,4 @@ def preprocess(soup: BeautifulSoup, output: str) -> None:
 
 The `output` argument lets you modify the soup *depending on which file is being generated*.
 
-Have a look at [our own pre-processing function](https://pawamoy.github.io/mkdocs-llmstxt/reference/mkdocs_llmstxt/preprocess/#mkdocs_llmstxt.preprocess.autoclean) to get inspiration.
+Have a look at [our own cleaning function](https://pawamoy.github.io/mkdocs-llmstxt/reference/mkdocs_llmstxt/#mkdocs_llmstxt.autoclean) to get inspiration.

src/mkdocs_llmstxt/__init__.py

@@ -6,7 +6,9 @@
 from __future__ import annotations
 
 from mkdocs_llmstxt._internal.plugin import MkdocsLLMsTxtPlugin
+from mkdocs_llmstxt._internal.preprocess import autoclean
 
 __all__: list[str] = [
     "MkdocsLLMsTxtPlugin",
+    "autoclean",
 ]

src/mkdocs_llmstxt/_internal/config.py

@@ -1,21 +1,21 @@
-"""Configuration options for the MkDocs LLMsTxt plugin."""
+# Configuration options for the MkDocs LLMsTxt plugin.
 
 from __future__ import annotations
 
 from mkdocs.config import config_options as mkconf
 from mkdocs.config.base import Config as BaseConfig
 
 
-class FileConfig(BaseConfig):
+class _FileConfig(BaseConfig):
     """Sub-config for each Markdown file."""
 
     output = mkconf.Type(str)
     inputs = mkconf.ListOfItems(mkconf.Type(str))
 
 
-class PluginConfig(BaseConfig):
+class _PluginConfig(BaseConfig):
     """Configuration options for the plugin."""
 
     autoclean = mkconf.Type(bool, default=True)
     preprocess = mkconf.Optional(mkconf.File(exists=True))
-    files = mkconf.ListOfItems(mkconf.SubConfig(FileConfig))
+    files = mkconf.ListOfItems(mkconf.SubConfig(_FileConfig))

src/mkdocs_llmstxt/_internal/logger.py

@@ -1,4 +1,4 @@
-"""Logging functions."""
+# Logging functions.
 
 from __future__ import annotations
 
@@ -9,7 +9,7 @@
     from collections.abc import MutableMapping
 
 
-class PluginLogger(logging.LoggerAdapter):
+class _PluginLogger(logging.LoggerAdapter):
     """A logger adapter to prefix messages with the originating package name."""
 
     def __init__(self, prefix: str, logger: logging.Logger):
@@ -35,7 +35,7 @@ def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]
         return f"{self.prefix}: {msg}", kwargs
 
 
-def get_logger(name: str) -> PluginLogger:
+def _get_logger(name: str) -> _PluginLogger:
     """Return a logger for plugins.
 
     Arguments:
@@ -46,4 +46,4 @@ def get_logger(name: str) -> PluginLogger:
             prefixing each message with the plugin package name.
     """
     logger = logging.getLogger(f"mkdocs.plugins.{name}")
-    return PluginLogger(name.split(".", 1)[0], logger)
+    return _PluginLogger(name.split(".", 1)[0], logger)

src/mkdocs_llmstxt/_internal/plugin.py

@@ -1,4 +1,4 @@
-"""MkDocs plugin that generates a Markdown file at the end of the build."""
+# MkDocs plugin that generates a Markdown file at the end of the build.
 
 from __future__ import annotations
 
@@ -16,9 +16,9 @@
 from mkdocs.exceptions import PluginError
 from mkdocs.plugins import BasePlugin
 
-from mkdocs_llmstxt._internal.config import PluginConfig
-from mkdocs_llmstxt._internal.logger import get_logger
-from mkdocs_llmstxt._internal.preprocess import autoclean, preprocess
+from mkdocs_llmstxt._internal.config import _PluginConfig
+from mkdocs_llmstxt._internal.logger import _get_logger
+from mkdocs_llmstxt._internal.preprocess import autoclean, _preprocess
 
 if TYPE_CHECKING:
     from typing import Any
@@ -28,10 +28,10 @@
     from mkdocs.structure.pages import Page
 
 
-logger = get_logger(__name__)
+_logger = _get_logger(__name__)
 
 
-class MkdocsLLMsTxtPlugin(BasePlugin[PluginConfig]):
+class MkdocsLLMsTxtPlugin(BasePlugin[_PluginConfig]):
     """The MkDocs plugin to generate an `llms.txt` file.
 
     This plugin defines the following event hooks:
@@ -44,9 +44,11 @@ class MkdocsLLMsTxtPlugin(BasePlugin[PluginConfig]):
     """
 
     mkdocs_config: MkDocsConfig
+    """The global MkDocs configuration."""
 
     def __init__(self) -> None:
         self.html_pages: dict[str, dict[str, str]] = defaultdict(dict)
+        """Dictionary to store the HTML contents of pages."""
 
     def _expand_inputs(self, inputs: list[str], page_uris: list[str]) -> list[str]:
         expanded: list[str] = []
@@ -102,7 +104,7 @@ def on_page_content(self, html: str, *, page: Page, **kwargs: Any) -> str | None
         """
         for file in self.config.files:
             if page.file.src_uri in file["inputs"]:
-                logger.debug(f"Adding page {page.file.src_uri} to page {file['output']}")
+                _logger.debug(f"Adding page {page.file.src_uri} to page {file['output']}")
                 self.html_pages[file["output"]][page.file.src_uri] = html
         return html
 
@@ -139,11 +141,11 @@ def language_callback(tag: Tag) -> str:
             if self.config.autoclean:
                 autoclean(soup)
             if self.config.preprocess:
-                preprocess(soup, self.config.preprocess, file["output"])
+                _preprocess(soup, self.config.preprocess, file["output"])
 
             output_file = Path(config.site_dir).joinpath(file["output"])
             output_file.parent.mkdir(parents=True, exist_ok=True)
             markdown = mdformat.text(converter.convert_soup(soup), options={"wrap": "no"})
             output_file.write_text(markdown, encoding="utf8")
 
-            logger.info(f"Generated file /{file['output']}")
+            _logger.info(f"Generated file /{file['output']}")

src/mkdocs_llmstxt/_internal/preprocess.py

@@ -1,4 +1,4 @@
-"""HTML pre-processing."""
+# HTML pre-processing.
 
 from __future__ import annotations
 
@@ -28,7 +28,7 @@ def _load_module(module_path: str) -> ModuleType:
     raise RuntimeError("Spec or loader is null")
 
 
-def preprocess(soup: Soup, module_path: str, output: str) -> None:
+def _preprocess(soup: Soup, module_path: str, output: str) -> None:
     """Pre-process HTML with user-defined functions.
 
     Parameters: