mkdocs-include-markdown-plugin 6.0.3__tar.gz → 6.0.5__tar.gz

{mkdocs_include_markdown_plugin-6.0.3 → mkdocs_include_markdown_plugin-6.0.5}/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2017-2023 Joe Rickerby and contributors
+   Copyright 2017-2024 Joe Rickerby and contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{mkdocs_include_markdown_plugin-6.0.3 → mkdocs_include_markdown_plugin-6.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 6.0.3
+Version: 6.0.5
 Summary: Mkdocs Markdown includer plugin.
 Project-URL: Source, https://github.com/mondeja/mkdocs-include-markdown-plugin
 Project-URL: Documentation, https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation
@@ -96,46 +96,51 @@ plugins:
       end: <!--end-->
 ```
 
-- <a name="config_tags" href="#config_tags">#</a> **opening_tag** and
-  **closing_tag**: The default opening and closing tags. By default are
-  `{%` and `%}`.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        opening_tag: "{!"
-        closing_tag: "!}"
-  ```
-
-- <a name="config_exclude" href="#config_exclude">#</a> **exclude**: Define
-  global exclusion wildcard patterns. Relative paths defined here will be
-  relative to the _docs/_ directory.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        exclude:
-          - LICENSE.md
-          - api/**
-  ```
-
-- <a name="config_cache" href="#config_cache">#</a> **cache**: Define a
-  expiration time in seconds for cached HTTP requests when including
-  from URLs.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        cache: 600
-  ```
-
-  In order to use this feature, the dependency [platformdirs] must be installed.
-  You can include it in the installation of the plugin adding the `cache` extra:
-
-  ```txt
-  # requirements.txt
-  mkdocs-include-markdown-plugin[cache]
-  ```
+#### `opening_tag` and `closing_tag`
+
+Default opening and closing tags. When not specified they are `{%` and `%}`.
+
+```yaml
+plugins:
+  - include-markdown:
+      opening_tag: "{!"
+      closing_tag: "!}"
+```
+
+<!-- mdpo-disable-next-line -->
+
+#### `exclude`
+
+Global exclusion wildcard patterns. Relative paths defined here will be
+relative to the [`docs_dir`] directory.
+
+```yaml
+plugins:
+  - include-markdown:
+      exclude:
+        - LICENSE.md
+        - api/**
+```
+
+<!-- mdpo-disable-next-line -->
+
+#### `cache`
+
+Expiration time in seconds for cached HTTP requests when including from URLs.
+
+```yaml
+plugins:
+  - include-markdown:
+      cache: 600
+```
+
+In order to use this feature, the dependency [platformdirs] must be installed.
+You can include it in the installation of the plugin adding the `cache` extra:
+
+```txt
+# requirements.txt
+mkdocs-include-markdown-plugin[cache]
+```
 
 ### Reference
 
@@ -148,7 +153,9 @@ Paths of included files can be either:
 - Local files:
   - Absolute paths (starting with a path separator).
   - Relative from the file that includes them (starting with `./` or `../`).
-  - Relative from the _docs/_ directory.
+  - Relative to the [`docs_dir`] directory. For instance if your `docs_dir` is
+    _./docs/_, then `includes/header.md` will match the file
+    _./docs/includes/header.md_.
 - [Bash wildcard globs] matching multiple local files.
 
 File paths to include and string arguments can be wrapped by double `"` or
@@ -212,7 +219,7 @@ content to include.
 
 ```jinja
 {%
-   include-markdown 'docs/includes/header.md'
+   include-markdown 'includes/header.md'
    start='<!--\n\ttable-start\n-->'
    end='<!--\n\ttable-end\n-->'
    rewrite-relative-urls=false
@@ -222,7 +229,7 @@ content to include.
 
 ```jinja
 {%
-   include-markdown "docs/includes/header.md"
+   include-markdown "includes/header.md"
    heading-offset=1
 %}
 ```
@@ -303,6 +310,10 @@ Includes the content of a file or a group of files.
   [giving me the permissions][cibuildwheel-470] to separate this plugin from the
   documentation of [cibuildwheel][cibuildwheel-repo-link].
 
+[Bash wildcard globs]: https://facelessuser.github.io/wcmatch/glob/#syntax
+
+<!-- mdpo-disable -->
+
 [pypi-link]: https://pypi.org/project/mkdocs-include-markdown-plugin
 [pypi-version-badge-link]: https://img.shields.io/pypi/v/mkdocs-include-markdown-plugin?logo=pypi&logoColor=white
 [tests-image]: https://img.shields.io/github/actions/workflow/status/mondeja/mkdocs-include-markdown-plugin/ci.yml?logo=github&label=tests&branch=master
@@ -316,4 +327,4 @@ Includes the content of a file or a group of files.
 [cibuildwheel-repo-link]: https://github.com/pypa/cibuildwheel
 [es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
 [fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md
-[Bash wildcard globs]: https://facelessuser.github.io/wcmatch/glob/#syntax
+[`docs_dir`]: https://www.mkdocs.org/user-guide/configuration/#docs_dir

{mkdocs_include_markdown_plugin-6.0.3 → mkdocs_include_markdown_plugin-6.0.5}/README.md

@@ -61,46 +61,51 @@ plugins:
       end: <!--end-->
 ```
 
-- <a name="config_tags" href="#config_tags">#</a> **opening_tag** and
-  **closing_tag**: The default opening and closing tags. By default are
-  `{%` and `%}`.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        opening_tag: "{!"
-        closing_tag: "!}"
-  ```
-
-- <a name="config_exclude" href="#config_exclude">#</a> **exclude**: Define
-  global exclusion wildcard patterns. Relative paths defined here will be
-  relative to the _docs/_ directory.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        exclude:
-          - LICENSE.md
-          - api/**
-  ```
-
-- <a name="config_cache" href="#config_cache">#</a> **cache**: Define a
-  expiration time in seconds for cached HTTP requests when including
-  from URLs.
-
-  ```yaml
-  plugins:
-    - include-markdown:
-        cache: 600
-  ```
-
-  In order to use this feature, the dependency [platformdirs] must be installed.
-  You can include it in the installation of the plugin adding the `cache` extra:
-
-  ```txt
-  # requirements.txt
-  mkdocs-include-markdown-plugin[cache]
-  ```
+#### `opening_tag` and `closing_tag`
+
+Default opening and closing tags. When not specified they are `{%` and `%}`.
+
+```yaml
+plugins:
+  - include-markdown:
+      opening_tag: "{!"
+      closing_tag: "!}"
+```
+
+<!-- mdpo-disable-next-line -->
+
+#### `exclude`
+
+Global exclusion wildcard patterns. Relative paths defined here will be
+relative to the [`docs_dir`] directory.
+
+```yaml
+plugins:
+  - include-markdown:
+      exclude:
+        - LICENSE.md
+        - api/**
+```
+
+<!-- mdpo-disable-next-line -->
+
+#### `cache`
+
+Expiration time in seconds for cached HTTP requests when including from URLs.
+
+```yaml
+plugins:
+  - include-markdown:
+      cache: 600
+```
+
+In order to use this feature, the dependency [platformdirs] must be installed.
+You can include it in the installation of the plugin adding the `cache` extra:
+
+```txt
+# requirements.txt
+mkdocs-include-markdown-plugin[cache]
+```
 
 ### Reference
 
@@ -113,7 +118,9 @@ Paths of included files can be either:
 - Local files:
   - Absolute paths (starting with a path separator).
   - Relative from the file that includes them (starting with `./` or `../`).
-  - Relative from the _docs/_ directory.
+  - Relative to the [`docs_dir`] directory. For instance if your `docs_dir` is
+    _./docs/_, then `includes/header.md` will match the file
+    _./docs/includes/header.md_.
 - [Bash wildcard globs] matching multiple local files.
 
 File paths to include and string arguments can be wrapped by double `"` or
@@ -177,7 +184,7 @@ content to include.
 
 ```jinja
 {%
-   include-markdown 'docs/includes/header.md'
+   include-markdown 'includes/header.md'
    start='<!--\n\ttable-start\n-->'
    end='<!--\n\ttable-end\n-->'
    rewrite-relative-urls=false
@@ -187,7 +194,7 @@ content to include.
 
 ```jinja
 {%
-   include-markdown "docs/includes/header.md"
+   include-markdown "includes/header.md"
    heading-offset=1
 %}
 ```
@@ -268,6 +275,10 @@ Includes the content of a file or a group of files.
   [giving me the permissions][cibuildwheel-470] to separate this plugin from the
   documentation of [cibuildwheel][cibuildwheel-repo-link].
 
+[Bash wildcard globs]: https://facelessuser.github.io/wcmatch/glob/#syntax
+
+<!-- mdpo-disable -->
+
 [pypi-link]: https://pypi.org/project/mkdocs-include-markdown-plugin
 [pypi-version-badge-link]: https://img.shields.io/pypi/v/mkdocs-include-markdown-plugin?logo=pypi&logoColor=white
 [tests-image]: https://img.shields.io/github/actions/workflow/status/mondeja/mkdocs-include-markdown-plugin/ci.yml?logo=github&label=tests&branch=master
@@ -281,4 +292,4 @@ Includes the content of a file or a group of files.
 [cibuildwheel-repo-link]: https://github.com/pypa/cibuildwheel
 [es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
 [fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md
-[Bash wildcard globs]: https://facelessuser.github.io/wcmatch/glob/#syntax
+[`docs_dir`]: https://www.mkdocs.org/user-guide/configuration/#docs_dir

{mkdocs_include_markdown_plugin-6.0.3 → mkdocs_include_markdown_plugin-6.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-include-markdown-plugin"
-version = "6.0.3"
+version = "6.0.5"
 description = "Mkdocs Markdown includer plugin."
 readme = "README.md"
 license = "Apache-2.0"
@@ -74,7 +74,7 @@ dependencies = ["pytest~=7.0", "coverage~=6.4", "covdefaults"]
 
 [[tool.hatch.envs.tests.matrix]]
 python = ["py38", "py39", "py310", "py311", "py312"]
-mkdocs = ["1.4.0", "1.4.3", "1.5.0", "1.5.1"]
+mkdocs = ["1.4.0", "1.4.3", "1.5.0", "1.5.3"]
 cache = ["yes", "no"]
 
 [tool.hatch.envs.tests.overrides]
@@ -82,7 +82,7 @@ matrix.mkdocs.dependencies = [
   { value = "mkdocs==1.4.0", if = ["1.4.0"] },
   { value = "mkdocs==1.4.3", if = ["1.4.3"] },
   { value = "mkdocs==1.5.0", if = ["1.5.0"] },
-  { value = "mkdocs==1.5.1", if = ["1.5.1"] },
+  { value = "mkdocs==1.5.3", if = ["1.5.3"] },
 ]
 matrix.cache.dependencies = [{ value = "platformdirs", if = ["yes"] }]
 
@@ -103,9 +103,9 @@ targets = [{ file = "pyproject.toml" }]
 [tool.project-config]
 cache = "2 days"
 style = [
-  "gh://mondeja/project-config-styles@v5/base/pre-commit/md2po2md.json5",
-  "gh://mondeja/project-config-styles@v5/python/base.json5",
-  "gh://mondeja/project-config-styles@v5/python/mypy.json5",
+  "gh://mondeja/project-config-styles@v5.2.1/base/pre-commit/md2po2md.json5",
+  "gh://mondeja/project-config-styles@v5.2.1/python/base.json5",
+  "gh://mondeja/project-config-styles@v5.2.1/python/mypy.json5",
 ]
 
 [tool.coverage.run]
@@ -121,6 +121,8 @@ fail_under = 1
 [tool.ruff]
 line-length = 80
 target-version = "py38"
+
+[tool.ruff.lint]
 select = [
   "W",
   "B",
@@ -148,23 +150,25 @@ select = [
   "COM",
   "SLOT",
 ]
+ignore = ["G004"]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.ruff.flake8-quotes]
+[tool.ruff.lint.flake8-quotes]
 inline-quotes = "single"
 multiline-quotes = "single"
 
-[tool.ruff.flake8-pytest-style]
+[tool.ruff.lint.flake8-pytest-style]
 fixture-parentheses = false
 parametrize-values-type = "tuple"
 parametrize-values-row-type = "tuple"
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 lines-after-imports = 2
 combine-as-imports = true
 force-wrap-aliases = true
+known-first-party = ["mkdocs_include_markdown_plugin", "testing_helpers"]
 known-local-folder = ["tests"]
 required-imports = ["from __future__ import annotations"]
 extra-standard-library = [
@@ -174,7 +178,7 @@ extra-standard-library = [
   "wsgiref.types"
 ]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/**" = [
   "I002",
   "D100",

{mkdocs_include_markdown_plugin-6.0.3 → mkdocs_include_markdown_plugin-6.0.5}/src/mkdocs_include_markdown_plugin/event.py

@@ -48,7 +48,9 @@ class Settings:  # noqa: D101
     exclude: list[str] | None
 
 
-logger = logging.getLogger('mkdocs.plugins.mkdocs_include_markdown_plugin')
+# TODO: when Mkdocs < 1.5.0 support is dropped, use
+# mkdocs.plugin.get_plugin_logger
+logger = logging.getLogger('mkdocs.plugins.include_markdown')
 
 
 def lineno_from_content_start(content: str, start: int) -> int:
@@ -276,26 +278,15 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     markdown,
                     directive_match_start,
                 )
+                relative_path = os.path.relpath(page_src_path, docs_dir)
                 logger.warning(
                     (
-                        "Delimiter {delimiter_name} '{delimiter_value}'"
-                        " of '{directive}' directive at"
-                        ' {relative_path}:{line_number}'
-                        ' not detected in the file{plural_suffix}'
-                        ' {readable_files_to_include}'
+                        f"Delimiter {delimiter_name} '{delimiter_value}'"
+                        " of 'include' directive at"
+                        f' {relative_path}:{lineno}'
+                        f' not detected in the file{plural_suffix}'
+                        f' {readable_files_to_include}'
                     ),
-                    extra={
-                        'delimiter_name': delimiter_name,
-                        'delimiter_value': delimiter_value,
-                        'directive': 'include',
-                        'relative_path': os.path.relpath(
-                            page_src_path,
-                            docs_dir,
-                        ),
-                        'line_number': lineno,
-                        'plural_suffix': plural_suffix,
-                        'readable_files_to_include': readable_files_to_include,
-                    },
                 )
 
         return text_to_include
@@ -453,8 +444,8 @@ def get_file_content(  # noqa: PLR0913, PLR0915
             arguments_string,
         )
         if offset_match:
-            offset = offset_match[1]
-            if offset == '':
+            offset_raw_value = offset_match[1]
+            if offset_raw_value == '':
                 lineno = lineno_from_content_start(
                     markdown,
                     directive_match_start,
@@ -465,15 +456,15 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     f' {os.path.relpath(page_src_path, docs_dir)}:{lineno}',
                 )
             try:
-                offset = int(offset)
+                offset = int(offset_raw_value)
             except ValueError:
                 lineno = lineno_from_content_start(
                     markdown,
                     directive_match_start,
                 )
                 raise PluginError(
-                    f"Invalid 'heading-offset' argument \"{offset}\" in"
-                    " 'include-markdown' directive at "
+                    f"Invalid 'heading-offset' argument \"{offset_raw_value}\""
+                    " in 'include-markdown' directive at "
                     f'{os.path.relpath(page_src_path, docs_dir)}:{lineno}',
                 ) from None
         else:
@@ -565,7 +556,7 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     )
                 )
 
-            if offset_match:
+            if offset:
                 new_text_to_include = process.increase_headings_offset(
                     new_text_to_include,
                     offset=offset + cumulative_heading_offset,
@@ -586,26 +577,15 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     markdown,
                     directive_match_start,
                 )
+                relative_path = os.path.relpath(page_src_path, docs_dir)
                 logger.warning(
                     (
-                        "Delimiter {delimiter_name} '{delimiter_value}' of"
-                        " '{directive}' directive at"
-                        ' {relative_path}:{line_number}'
-                        ' not detected in the file{plural_suffix}'
-                        ' {readable_files_to_include}'
+                        f"Delimiter {delimiter_name} '{delimiter_value}' of"
+                        " 'include-markdown' directive at"
+                        f' {relative_path}:{lineno}'
+                        f' not detected in the file{plural_suffix}'
+                        f' {readable_files_to_include}'
                     ),
-                    extra={
-                        'delimiter_name': delimiter_name,
-                        'delimiter_value': delimiter_value,
-                        'directive': 'include-markdown',
-                        'relative_path': os.path.relpath(
-                            page_src_path,
-                            docs_dir,
-                        ),
-                        'line_number': lineno,
-                        'plural_suffix': plural_suffix,
-                        'readable_files_to_include': readable_files_to_include,
-                    },
                 )
 
         return text_to_include