Add reference docs for the template tags

matthiask · matthiask · commit c09385e0c494 · 2022-05-04T18:02:36.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -16,12 +16,12 @@ repos:
         language: system
         always_run: true
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.1
+    rev: v2.32.0
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.4.0
+    rev: 1.6.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "3.2"]
@@ -46,13 +46,13 @@ repos:
         args: [--list-different, --no-semi]
         exclude: "^conf/|.*\\.html$"
   - repo: https://github.com/pre-commit/mirrors-eslint
-    rev: v8.12.0
+    rev: v8.14.0
     hooks:
       - id: eslint
         args: [--fix]
         verbose: true
         additional_dependencies:
-          - eslint@8.12.0
+          - eslint@8.14.0
           - eslint-config-prettier@8.5.0
           - "@babel/core"
           - "@babel/eslint-parser"
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 release = subprocess.check_output(
     "git fetch --tags; git describe",
     shell=True,
-    universal_newlines=True,
+    text=True,
 ).strip()
 language = "en"
 
diff --git a/docs/ref/templatetags.rst b/docs/ref/templatetags.rst
@@ -0,0 +1,7 @@
+.. _ref-templatetags:
+
+Template tags (``feincms3.templatetags.feincms3``)
+==================================================
+
+.. automodule:: feincms3.templatetags.feincms3
+   :members:
diff --git a/feincms3/templatetags/feincms3.py b/feincms3/templatetags/feincms3.py
@@ -160,6 +160,14 @@ def translations(iterable):
 
 @register.simple_tag
 def maybe_target_blank(href, *, attributes='target="_blank" rel="noopener"'):
+    """
+    Return the value of ``attributes`` if the first argument isn't a first party link
+    (as determined by :func:`~feincms3.utils.is_first_party_link`)
+
+    Usage::
+
+        <a href="{{ url }}" {% maybe_target_blank url %}>...</a>
+    """
     if is_first_party_link(href):
         return ""
     return mark_safe(attributes)
