mkdocs-partial 1.3.1__tar.gz → 1.4.1__tar.gz

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-partial
-Version: 1.3.1
+Version: 1.4.1
 Summary: Mkdocs Partial Documentation
 Author: Exorids
 Project-URL: Homepage, https://github.com/exordis/mkdocs-partial
@@ -27,5 +27,6 @@ Requires-Dist: pytest<8.0.0,>=7.1.3; extra == "test"
 Requires-Dist: pytest-cov<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-mock<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-resource-path==1.3.0; extra == "test"
+Requires-Dist: docs-documentation; extra == "test"
 
 Mkdocs Partial Documentation

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/docs_package_plugin.py

@@ -41,6 +41,12 @@ class DocsPackagePluginConfig(Config):
     name = config_options.Optional(config_options.Type(str))
     blog_categories = config_options.Optional(config_options.Type(str))
 
+    def patch(self, patch: DocsPackagePluginConfig):
+        if patch.docs_path is not None:
+            self.docs_path = patch.docs_path
+        if patch.directory is not None:
+            self.directory = patch.directory
+
 
 class DocsPackagePlugin(BasePlugin[DocsPackagePluginConfig]):
     supports_multiple_instances = True

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/integrations/material_blog_integration.py

@@ -38,7 +38,7 @@ class MaterialBlogsIntegration(ABC):
             self.__docs_dir = config.docs_dir
             self.__partial = os.path.join(self.__docs_dir, blog_posts, "partial")
             self.__target = os.path.join(self.__partial, name)
-            self.__categories = [] if categories == "" else categories.split("/")
+            self.__categories = [] if categories == "" or categories is None else categories.split("/")
             self.__docs_path = docs_path
         return self.__enabled
 

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/packages/packager.py

@@ -13,6 +13,7 @@ from tempfile import NamedTemporaryFile
 from typing import List
 
 from packaging.requirements import Requirement
+from packaging.version import Version
 
 from mkdocs_partial import MODULE_NAME_RESTRICTED_CHARS, version
 from mkdocs_partial.docs_package_plugin import DocsPackagePlugin
@@ -62,8 +63,19 @@ class Packager(ABC):
                 requirements = self.parse_requirements(requirements_path)
 
         if add_self_dependency:
-            self_dependency = Requirement(f"mkdocs-partial >={version.__version__}")
-            requirements.append(self_dependency)
+            parsed_version = Version(version.__version__)
+            base_version = Version(parsed_version.base_version)
+            if base_version == parsed_version:
+                self_dependency = f"mkdocs-partial >={version.__version__}"
+            elif base_version.micro > 0:
+                self_dependency = (
+                    f"mkdocs-partial > {parsed_version.major}.{parsed_version.minor}.{parsed_version.micro - 1}."
+                )
+            elif base_version.minor > 0:
+                self_dependency = f"mkdocs-partial > {parsed_version.major}.{parsed_version.minor - 1}.0"
+            else:
+                self_dependency = f"mkdocs-partial > {parsed_version.major - 1}.0.0"
+            requirements.append(Requirement(self_dependency))
 
         if freeze:
             requirements = Packager.freeze_requirements(requirements)

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/packages/templates/site-package/package/entry_point.py.j2

@@ -6,6 +6,5 @@ from {{module_name}} import __version__
 from mkdocs_partial.site_entry_point import SiteEntryPoint
 
 def run():
-    print({{module_name}})
     script_dir = os.path.dirname(__file__)
     SiteEntryPoint(__version__, os.path.join(script_dir, "site"),"{{package_name}}").run()

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/partial_docs_plugin.py

@@ -23,7 +23,7 @@ class PartialDocsPluginConfig(Config):
 
 
 class PartialDocsPlugin(BasePlugin[PartialDocsPluginConfig]):
-    docs_path_overrides: Dict[str, str] = {}
+    overrides: Dict[str, DocsPackagePluginConfig] = {}
 
     def __init__(self):
         self.is_serve = False
@@ -73,19 +73,24 @@ class PartialDocsPlugin(BasePlugin[PartialDocsPluginConfig]):
 
     # Load doc package plugins
     def _load(self, option: Plugins) -> List[tuple[str, DocsPackagePlugin]]:
+        loaded_plugins = []
         for entrypoint in option.installed_plugins.values():
             try:
                 plugin_class = entrypoint.load()
             except ModuleNotFoundError:
                 continue
             if issubclass(plugin_class, DocsPackagePlugin) and plugin_class != DocsPackagePlugin:
-                plugin_config: DocsPackagePluginConfig = self.config.packages.setdefault(
-                    entrypoint.name, DocsPackagePluginConfig()
-                )
-                if entrypoint.name in PartialDocsPlugin.docs_path_overrides:
-                    plugin_config.docs_path = PartialDocsPlugin.docs_path_overrides[entrypoint.name]
-
+                override = PartialDocsPlugin.overrides.setdefault(entrypoint.name, DocsPackagePluginConfig())
+                plugin_config: DocsPackagePluginConfig = self.config.packages.setdefault(entrypoint.name, override)
+                plugin_config.patch(override)
                 name, plugin = option.load_plugin_with_namespace(entrypoint.name, plugin_config.data)
+                loaded_plugins += [entrypoint.name]
+                yield name, cast(DocsPackagePlugin, plugin)
+        for name, override in self.overrides.items():
+            if name not in loaded_plugins:
+                plugin_config: DocsPackagePluginConfig = override
+                plugin_config.name = name
+                name, plugin = option.load_plugin_with_namespace("docs_package", plugin_config.data)
                 yield name, cast(DocsPackagePlugin, plugin)
 
     def _get_plugin(self, method: Callable):

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial/site_entry_point.py

@@ -11,20 +11,29 @@ from pathlib import Path
 
 import yaml
 from mkdocs.__main__ import build_command as mkdocs_build_command, serve_command as mkdocs_serve_command
+from mkdocs.plugins import get_plugins
 
 from mkdocs_partial.argparse_types import directory
+from mkdocs_partial.docs_package_plugin import DocsPackagePlugin, DocsPackagePluginConfig
 from mkdocs_partial.entry_point import add_command_parser
 from mkdocs_partial.mkdcos_helpers import normalize_path
 from mkdocs_partial.partial_docs_plugin import PartialDocsPlugin
 
 
-def local_docs(value: str):
+def local_docs(value: str, check_path: bool = True):
     values = value.split("=", maxsplit=1)
     plugin = values[0]
-    path = "/docs" if len(values) <= 1 else values[1]
-    if not os.path.isdir(path):
-        raise ArgumentTypeError(f"directory '{path}' for plugin '{plugin}' does not exist")
-    return plugin, normalize_path(path)
+    docs_directory = None
+    if len(values) <= 1:
+        path = "/docs"
+    else:
+        values = values[1].rsplit("::", maxsplit=1)
+        docs_directory = None if len(values) <= 1 else values[1]
+        path = values[0]
+
+    if check_path and not os.path.isdir(path):
+        raise ArgumentTypeError(f"directory '{path}' for plugin '{plugin}' does not exist.")
+    return plugin, normalize_path(path), docs_directory
 
 
 class SiteEntryPoint(ABC):
@@ -62,6 +71,9 @@ class SiteEntryPoint(ABC):
             func=lambda args, argv: self.mkdocs(mkdocs_build_command, args, argv),
         )
 
+        self.add_command_parser(subparsers, "list", "lists partial docs plugins", func=self.list)
+        self.add_command_parser(subparsers, "version", "outputs site version", func=self.version)
+
         dump_command = self.add_command_parser(subparsers, "dump", "dump site files to the dir", func=self.dump)
         dump_command.add_argument(
             "--output", required=False, type=directory, help="Output directory. Default - Current directory"
@@ -93,10 +105,40 @@ class SiteEntryPoint(ABC):
     @staticmethod
     def add_mkdocs_command_parser(subparsers, name, help_text, func):
         command_parser = add_command_parser(subparsers, name, help_text, func)
-        command_parser.add_argument("--local-docs", required=False, type=local_docs)
-        command_parser.add_argument("--site-root", required=False, type=directory)
+        command_parser.add_argument(
+            "--local-docs",
+            required=False,
+            type=local_docs,
+            help="loads local directory as `docs_package` plugin content. "
+            "Format <plugin name>[=<docs_path>[::<directory>]]. "
+            "If `docs_path` is not provided `/docs` is used as default. "
+            "If plugin is configured within site mkdocs.yml `directory` overrides "
+            "corresponding plugin config option. "
+            "If plugin not configured within site mkdocs.yml, it is added to config",
+        )
+        command_parser.add_argument(
+            "--site-root",
+            required=False,
+            type=directory,
+            help="loads local directory as site `docs_dir` instead of the content packed with " "site package",
+        )
         return command_parser
 
+    @staticmethod
+    def list(args, argv):  # pylint: disable=unused-argument
+        for name, entrypoint in get_plugins().items():
+            try:
+                plugin_class = entrypoint.load()
+            except ModuleNotFoundError:
+                continue
+            if issubclass(plugin_class, DocsPackagePlugin) and plugin_class != DocsPackagePlugin:
+                print(name)
+        return True, None
+
+    def version(self, args, argv):  # pylint: disable=unused-argument
+        print(self.__version)
+        return True, None
+
     def mkdocs(self, command, args, argv):
 
         site_root_path = args.site_root
@@ -114,8 +156,11 @@ class SiteEntryPoint(ABC):
             return False, f"{mkdocs_yaml_path} must define 'partial_docs' plugin"
 
         if args.local_docs is not None:
-            plugin, docs_path = args.local_docs
-            PartialDocsPlugin.docs_path_overrides[plugin] = docs_path
+            plugin, docs_path, docs_directory = args.local_docs
+            override = DocsPackagePluginConfig()
+            override.docs_path = docs_path
+            override.directory = docs_directory
+            PartialDocsPlugin.overrides[plugin] = override
 
         current_dir = os.getcwd()
         os.chdir(site_root_path)

mkdocs_partial-1.4.1/mkdocs_partial/version.py

@@ -0,0 +1 @@
+__version__ = "1.4.1"

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-partial
-Version: 1.3.1
+Version: 1.4.1
 Summary: Mkdocs Partial Documentation
 Author: Exorids
 Project-URL: Homepage, https://github.com/exordis/mkdocs-partial
@@ -27,5 +27,6 @@ Requires-Dist: pytest<8.0.0,>=7.1.3; extra == "test"
 Requires-Dist: pytest-cov<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-mock<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-resource-path==1.3.0; extra == "test"
+Requires-Dist: docs-documentation; extra == "test"
 
 Mkdocs Partial Documentation

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial.egg-info/SOURCES.txt

@@ -44,4 +44,5 @@ mkdocs_partial/templating/markdown_extension.py
 mkdocs_partial/templating/templater.py
 mkdocs_partial/templating/templater_extension.py
 mkdocs_partial/templating/version.py
-tests/test_docs_package_plugin.py
+tests/test_docs_package_plugin.py
+tests/test_site_entry_point.py

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/mkdocs_partial.egg-info/requires.txt

@@ -16,3 +16,4 @@ pytest<8.0.0,>=7.1.3
 pytest-cov<4.0.0,>=3.0.0
 pytest-mock<4.0.0,>=3.0.0
 pytest-resource-path==1.3.0
+docs-documentation

{mkdocs_partial-1.3.1 → mkdocs_partial-1.4.1}/setup.cfg

@@ -38,6 +38,7 @@ test =
 	pytest-cov >=3.0.0,<4.0.0
 	pytest-mock >=3.0.0,<4.0.0
 	pytest-resource-path == 1.3.0
+	docs-documentation
 
 [options.packages.find]
 exclude = 

mkdocs_partial-1.4.1/tests/test_site_entry_point.py

@@ -0,0 +1,27 @@
+import pytest
+
+from mkdocs_partial.site_entry_point import SiteEntryPoint, local_docs
+
+
+def test_list(capsys):
+    SiteEntryPoint("0.1.0").list(None, None)
+    captured = capsys.readouterr().out.splitlines()
+    assert len(captured) > 0
+    assert "docs-documentation" in captured
+
+
+@pytest.mark.parametrize(
+    "value,plugin, docs_path, docs_directory",
+    [
+        (r"test=d:\tmp\local-docs\docs::test/sub", "test", r"d:/tmp/local-docs/docs", r"test/sub"),
+        (r"test=/tmp/local-docs/docs::test/sub", "test", r"/tmp/local-docs/docs", r"test/sub"),
+        (r"test=/tmp/local-docs/docs", "test", r"/tmp/local-docs/docs", None),
+        (r"test", "test", r"/docs", None),
+    ],
+    ids=["windows path", "linux path", "directory fallback", "path fallback"],
+)
+def test_local_docs(value, plugin, docs_path, docs_directory):
+    actual_plugin, actual_docs_path, actual_docs_directory = local_docs(value, False)
+    assert actual_plugin == plugin
+    assert actual_docs_path == docs_path or (actual_docs_path is None and docs_path is None)
+    assert actual_docs_directory == docs_directory

mkdocs_partial-1.3.1/mkdocs_partial/version.py

@@ -1 +0,0 @@
-__version__ = "1.3.1"