Add new option 'enabled', see #57

Author: timvink

docs/options.md

@@ -11,6 +11,7 @@ plugins:
         fallback_to_empty: false
         exclude:
             - index.md
+        enabled: true
 ```
 
 ## `show_contribution`
@@ -50,3 +51,21 @@ plugins:
         - another_page.md
         - folder/*
 ```
+
+## `enabled`
+
+Default is `true`. Enables you to deactivate this plugin. A possible use case is local development where you might want faster build times and/or do not have git available. It's recommended to use this option with an environment variable together with a default fallback (introduced in `mkdocs` v1.2.1, see [docs](https://www.mkdocs.org/user-guide/configuration/#environment-variables)). Example:
+
+```yaml
+# mkdocs.yml
+plugins:
+  - git-authors:
+      enabled: !ENV [ENABLED_GIT_AUTHORS, True]
+```
+
+Which enables you do disable the plugin locally using:
+
+```bash
+export ENABLED_GIT_AUTHORS=false
+mkdocs serve
+```

mkdocs_git_authors_plugin/plugin.py

@@ -18,6 +18,7 @@ class GitAuthorsPlugin(BasePlugin):
         ("count_empty_lines", config_options.Type(bool, default=True)),
         ("fallback_to_empty", config_options.Type(bool, default=False)),
         ("exclude", config_options.Type(list, default=[])),
+        ("enabled", config_options.Type(bool, default=True)),
         # ('sort_authors_by_name', config_options.Type(bool, default=True)),
         # ('sort_reverse', config_options.Type(bool, default=False))
     )
@@ -45,6 +46,9 @@ def on_config(self, config, **kwargs):
         Returns:
             (updated) configuration object
         """
+        if not self.config.get('enabled'):
+            return config
+        
         try:
             self._repo = Repo()
             self._fallback = False
@@ -87,8 +91,11 @@ def on_files(self, files, config, **kwargs):
         Returns:
             global files collection
         """
+        if not self.config.get('enabled'):
+            return
         if self._fallback:
             return
+        
         for file in files:
             path = file.abs_src_path
             if path.endswith(".md"):
@@ -117,6 +124,9 @@ def on_page_content(self, html, page, config, files, **kwargs):
         Returns:
             str: HTML text of page as string
         """
+        if not self.config.get('enabled'):
+            return html
+        
         # Exclude pages specified in config
         excluded_pages = self.config.get("exclude", [])
         if exclude(page.file.src_path, excluded_pages):
@@ -153,7 +163,9 @@ def on_page_markdown(self, markdown, page, config, files, **kwargs):
         Returns:
             str: Markdown source text of page as string
         """
-
+        if not self.config.get('enabled'):
+            return markdown
+        
         # Exclude pages specified in config
         excluded_pages = self.config.get("exclude", [])
         if exclude(page.file.src_path, excluded_pages):
@@ -206,6 +218,8 @@ def on_page_context(self, context, page, config, nav, **kwargs):
         Returns:
             dict: template context variables
         """
+        if not self.config.get('enabled'):
+            return context
         if self._fallback:
             return context
 

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="mkdocs-git-authors-plugin",
-    version="0.5",
+    version="0.6",
     description="Mkdocs plugin to display git authors of a page",
     long_description=long_description,
     long_description_content_type="text/markdown",

tests/basic_setup/mkdocs_complete_material_disabled.yml

@@ -0,0 +1,16 @@
+site_name: test gitauthors_plugin with material theme and git-revision-date
+use_directory_urls: true
+
+theme:
+    name: 'material'
+    custom_dir: 'docs/theme'
+    language: nl
+
+plugins:
+    - search
+    - git-authors:
+        count_empty_lines: false
+        show_contribution: true
+        show_line_count: true
+        enabled: false
+    - git-revision-date-localized

tests/test_basic.py

@@ -81,6 +81,19 @@ def test_exclude_working(tmp_path):
     contents = page_file.read_text()
     assert not re.search("<span class='git-page-authors", contents)
 
+def test_enabled_working(tmp_path):
+
+    result = build_docs_setup("tests/basic_setup/mkdocs_complete_material_disabled.yml", tmp_path)
+    assert result.exit_code == 0, (
+        "'mkdocs build' command failed. Error: %s" % result.stdout
+    )
+
+    page_file = tmp_path / "page_with_tag/index.html"
+    assert page_file.exists(), "%s does not exist" % page_file
+
+    contents = page_file.read_text()
+    assert not re.search("<span class='git-page-authors", contents)
+
 
 
 def test_project_with_no_commits(tmp_path):