mkdocs-htmlproofer-plugin 1.2.1__tar.gz → 1.3.0__tar.gz

{mkdocs-htmlproofer-plugin-1.2.1/mkdocs_htmlproofer_plugin.egg-info → mkdocs-htmlproofer-plugin-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-htmlproofer-plugin
-Version: 1.2.1
+Version: 1.3.0
 Summary: A MkDocs plugin that validates URL in rendered HTML files
 Home-page: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
 Author: Manu Zhang
@@ -27,6 +27,8 @@ License-File: LICENSE.md
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -140,6 +142,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.1 → mkdocs-htmlproofer-plugin-1.3.0}/README.md

@@ -4,6 +4,8 @@
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -117,6 +119,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.1 → mkdocs-htmlproofer-plugin-1.3.0}/htmlproofer/plugin.py

@@ -70,6 +70,7 @@ class HtmlProoferPlugin(BasePlugin):
         ('validate_rendered_template', config_options.Type(bool, default=False)),
         ('ignore_urls', config_options.Type(list, default=[])),
         ('warn_on_ignored_urls', config_options.Type(bool, default=False)),
+        ('ignore_pages', config_options.Type(list, default=[])),
     )
 
     def __init__(self):
@@ -123,6 +124,12 @@ class HtmlProoferPlugin(BasePlugin):
             if any(fnmatch.fnmatch(url, ignore_url) for ignore_url in self.config['ignore_urls']):
                 if self.config['warn_on_ignored_urls']:
                     log_warning(f"ignoring URL {url} from {page.file.src_path}")
+            elif any(
+                fnmatch.fnmatch(page.file.src_path, ignore_page)
+                for ignore_page in self.config['ignore_pages']
+            ):
+                if self.config['warn_on_ignored_urls']:
+                    log_warning(f"ignoring URL {url} from {page.file.src_path}")
             else:
                 url_status = self.get_url_status(url, page.file.src_path, all_element_ids, opt_files)
                 if self.bad_url(url_status) and self.is_error(self.config, url, url_status):
@@ -152,7 +159,7 @@ class HtmlProoferPlugin(BasePlugin):
 
             if self.config['skip_downloads'] is False:
                 # Download the entire contents as to not break previous behaviour.
-                for _ in response.iter_content(chunk_size=1024):
+                for _ in response.iter_content(chunk_size=1024 * 1024):
                     pass
 
             return response.status_code

{mkdocs-htmlproofer-plugin-1.2.1 → mkdocs-htmlproofer-plugin-1.3.0/mkdocs_htmlproofer_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-htmlproofer-plugin
-Version: 1.2.1
+Version: 1.3.0
 Summary: A MkDocs plugin that validates URL in rendered HTML files
 Home-page: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
 Author: Manu Zhang
@@ -27,6 +27,8 @@ License-File: LICENSE.md
 
 *A [MkDocs](https://www.mkdocs.org/) plugin that validates URLs, including anchors, in rendered html files*.
 
+> Note: [MkDocs 1.6+ supports native validation of anchors](https://www.mkdocs.org/user-guide/configuration/#validation).
+
 ## Installation
 
 0. Prerequisites
@@ -140,6 +142,21 @@ plugins:
       warn_on_ignored_urls: true
 ```
 
+### `ignore_pages`
+
+Avoid validating the URLs on the given list of markdown pages by ignoring them altogether.
+Each page in the list supports unix style wildcards `*`, `[]`, `?`, etc.
+
+```yaml
+plugins:
+  - search
+  - htmlproofer:
+      raise_error: True
+      ignore_pages:
+        - path/to/file
+        - path/to/folder/*
+```
+
 ### `validate_external_urls`
 
 Avoids validating any external URLs (i.e those starting with http:// or https://).

{mkdocs-htmlproofer-plugin-1.2.1 → mkdocs-htmlproofer-plugin-1.3.0}/setup.py

@@ -9,7 +9,7 @@ def read(fname: str):
 
 setup(
     name='mkdocs-htmlproofer-plugin',
-    version='1.2.1',
+    version='1.3.0',
     description='A MkDocs plugin that validates URL in rendered HTML files',
     long_description=read('README.md'),
     long_description_content_type='text/markdown',