Optionally hide email addresses in rendered output

Sometimes, it may be prudent/desirable just to render the authors'
names, but not their email address.

In order to enable that, introduce a new configuration option,
show_email_address, which defaults to true. When true, it retains the
prior behaviour of rendering authors' names as "mailto:" links. When
false, it only renders the authors' names in plain text.

Also, add a unit test to check the new option's behaviour, and update
the documentation to explain its purpose.

Author: Florian Haas

docs/options.md

@@ -7,6 +7,7 @@ plugins:
     - git-authors:
         show_contribution: true
         show_line_count: true
+        show_email_address: true
         count_empty_lines: true
         fallback_to_empty: false
         exclude:
@@ -29,6 +30,12 @@ Example output:
 
 If this option is set to `true` (default: `false`) the number of lines per author is shown.
 
+## `show_email_address`
+
+If this option is set to `true` (default: `true`), then authors' names
+are rendered as a `mailto:` link pointing to their email address. If
+set to `false`, they are shown in plain text.
+
 ## `count_empty_lines`
 
 If this option is set to `true` (default: `false`) empty lines will count towards an authors' contribution.

mkdocs_git_authors_plugin/plugin.py

@@ -15,6 +15,7 @@ class GitAuthorsPlugin(BasePlugin):
     config_scheme = (
         ("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)),
         ("count_empty_lines", config_options.Type(bool, default=True)),
         ("fallback_to_empty", config_options.Type(bool, default=False)),
         ("exclude", config_options.Type(list, default=[])),

mkdocs_git_authors_plugin/util.py

@@ -50,15 +50,20 @@ def page_authors_summary(page, config: dict):
 
     authors = page.get_authors()
     authors_summary = []
+    author_name = ""
+
     for author in authors:
         contrib = (
             " (%s)" % author.contribution(page.path(), str)
             if page.repo().config("show_contribution") and len(page.get_authors()) > 1
             else ""
         )
-        authors_summary.append(
-            "<a href='mailto:%s'>%s</a>%s" % (author.email(), author.name(), contrib)
-        )
+        if page.repo().config("show_email_address"):
+            author_name = "<a href='mailto:%s'>%s</a>" % (author.email(), author.name())
+        else:
+            author_name = author.name()
+        authors_summary.append("%s%s" % (author_name, contrib))
+
     authors_summary = ", ".join(authors_summary)
     return "<span class='git-page-authors git-authors'>%s</span>" % authors_summary
 
@@ -87,6 +92,7 @@ def site_authors_summary(authors, config: dict):
     """
     show_contribution = config["show_contribution"]
     show_line_count = config["show_line_count"]
+    show_email_address = config["show_email_address"]
 
     result = """
 <span class='git-authors'>
@@ -97,11 +103,15 @@ def site_authors_summary(authors, config: dict):
             " (%s)" % author.contribution(None, str) if show_contribution else ""
         )
         lines = ": %s lines" % author.lines() if show_line_count else ""
+        author_name = ""
+        if show_email_address:
+            author_name = "<a href='mailto:%s'>%s</a>" % (author.email(), author.name())
+        else:
+            author_name = author.name()
         result += """
-    <li><a href='mailto:{author_email}'>{author_name}</a>{lines}{contribution}</li>
+    <li>{author_name}{lines}{contribution}</li>
     """.format(
-            author_email=author.email(),
-            author_name=author.name(),
+            author_name=author_name,
             lines=lines,
             contribution=contribution,
         )

tests/basic_setup/mkdocs_no_email.yml

@@ -0,0 +1,7 @@
+site_name: test gitauthors_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-authors:
+        show_email_address: false

tests/test_basic.py

@@ -79,6 +79,22 @@ def test_basic_working(tmp_path, mkdocs_file):
 
 
 
+def test_no_email(tmp_path):
+
+    result = build_docs_setup("tests/basic_setup/mkdocs_no_email.yml", tmp_path)
+    assert result.exit_code == 0, (
+        "'mkdocs build' command failed. Error: %s" % result.stdout
+    )
+
+    index_file = tmp_path / "index.html"
+    assert index_file.exists(), "%s does not exist" % index_file
+
+    contents = index_file.read_text()
+    assert re.search("<span class='git-page-authors", contents)
+    assert re.search("<li>Tim Vink</li>", contents)
+
+
+
 def test_exclude_working(tmp_path):
 
     result = build_docs_setup("tests/basic_setup/mkdocs_exclude.yml", tmp_path)

tests/test_util.py

@@ -29,6 +29,7 @@
 DEFAULT_CONFIG = {
     "show_contribution": False,
     "show_line_count": False,
+    "show_email_address": True,
     "count_empty_lines": True,
     "sort_authors_by_name": True,
     "sort_reverse": False,