From eaf9b8240069f7369f401fe048892043c8b173d3 Mon Sep 17 00:00:00 2001
From: Viicos <65306057+Viicos@users.noreply.github.com>
Date: Mon, 5 Feb 2024 13:47:05 +0100
Subject: [PATCH] feat: Add `show_labels` option to show/hide labels

Issue #120: https://github.com/mkdocstrings/python/issues/120
PR #130: https://github.com/mkdocstrings/python/pull/130
---
 docs/usage/configuration/members.md           | 46 +++++++++++++++++++
 src/mkdocstrings_handlers/python/handler.py   |  2 +
 .../templates/material/_base/labels.html      |  2 +-
 3 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/docs/usage/configuration/members.md b/docs/usage/configuration/members.md
index f558040f..1e5ff771 100644
--- a/docs/usage/configuration/members.md
+++ b/docs/usage/configuration/members.md
@@ -643,3 +643,49 @@ plugins:
 </ul>
 ////
 ///
+
+## `show_labels`
+
+- **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
+<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
+
+Whether to show labels of the members.
+
+```yaml title="in mkdocs.yml (global configuration)"
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          show_labels: true
+```
+
+```md title="or in docs/some_page.md (local configuration)"
+::: package.module
+    options:
+      show_labels: false
+```
+
+```python title="package/module.py"
+class SomeClass:
+    some_attr: int
+```
+
+/// admonition | Preview
+    type: preview
+
+//// tab | With labels
+<code class="highlight language-python">
+  <span class="n">some_attr</span><span class="p">:</span>
+  <span class="nb">int</span>
+</code>
+<small><code>instance-attribute</code></small>
+////
+
+//// tab | Without labels
+<code class="highlight language-python">
+  <span class="n">some_attr</span><span class="p">:</span>
+  <span class="nb">int</span>
+</code>
+////
+///
diff --git a/src/mkdocstrings_handlers/python/handler.py b/src/mkdocstrings_handlers/python/handler.py
index 7ffdaf6b..c5217e98 100644
--- a/src/mkdocstrings_handlers/python/handler.py
+++ b/src/mkdocstrings_handlers/python/handler.py
@@ -106,6 +106,7 @@ class PythonHandler(BaseHandler):
         "preload_modules": None,
         "allow_inspection": True,
         "summary": False,
+        "show_labels": True,
         "unwrap_annotated": False,
     }
     """Default handler configuration.
@@ -154,6 +155,7 @@ class PythonHandler(BaseHandler):
         group_by_category (bool): Group the object's children by categories: attributes, classes, functions, and modules. Default: `True`.
         show_submodules (bool): When rendering a module, show its submodules recursively. Default: `False`.
         summary (bool | dict[str, bool]): Whether to render summaries of modules, classes, functions (methods) and attributes.
+        show_labels (bool): Whether to show labels of the members. Default: `True`.
 
     Attributes: Docstrings options:
         docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`.
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/labels.html b/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
index 0c84067a..a35bffbb 100644
--- a/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
+++ b/src/mkdocstrings_handlers/python/templates/material/_base/labels.html
@@ -1,4 +1,4 @@
-{% if labels %}
+{% if config.show_labels and labels %}
   {{ log.debug("Rendering labels") }}
   <span class="doc doc-labels">
     {% for label in labels|sort %}