Add co authors as option

Author: fpozzobon

docs/options.md

@@ -8,6 +8,7 @@ plugins:
         show_contribution: true
         show_line_count: true
         show_email_address: true
+        add_co_authors: true
         href: "mailto:{email}"
         count_empty_lines: true
         fallback_to_empty: false

src/mkdocs_git_authors_plugin/config.py

@@ -6,6 +6,7 @@ class GitAuthorsPluginConfig(Config):
     show_contribution = config_options.Type(bool, default=False)
     show_line_count = config_options.Type(bool, default=False)
     show_email_address = config_options.Type(bool, default=True)
+    add_co_authors = config_options.Type(bool, default=False)
     href = config_options.Type(str, default="mailto:{email}")
     count_empty_lines = config_options.Type(bool, default=True)
     fallback_to_empty = config_options.Type(bool, default=False)

src/mkdocs_git_authors_plugin/git/repo.py

@@ -116,7 +116,10 @@ def get_commit(self, sha: str, **kwargs) -> Union[Any, None]:
         if not self._commits.get(sha):
             from .commit import Commit
 
-            kwargs["co_authors"] = self._get_co_authors(sha)
+            if self.config("add_co_authors"):
+                kwargs["co_authors"] = self._get_co_authors(sha)
+            else:
+                kwargs["co_authors"] = []
             self._commits[sha] = Commit(self, sha, **kwargs)
         return self._commits.get(sha)
 

tests/basic_setup/mkdocs_add_co_authors.yml

@@ -0,0 +1,9 @@
+site_name: test gitauthors_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-authors:
+        add_co_authors: true
+        ignore_authors:
+            - 'guts@users.noreply.github.com'

tests/test_basic.py

@@ -143,7 +143,7 @@ def test_ignore_authors_working(tmp_path) -> None:
 
 
 def test_co_authors_working(tmp_path) -> None:
-    result = build_docs_setup("tests/basic_setup/mkdocs_ignore_authors.yml", tmp_path)
+    result = build_docs_setup("tests/basic_setup/mkdocs_add_co_authors.yml", tmp_path)
     assert (
         result.exit_code == 0
     ), f"'mkdocs build' command failed. Error: {result.stdout}"