emphasize @deprecated decorators (#750)

mitmproxy · Oct 11, 2024 · 308c3a1 · 308c3a1
1 parent 9ac4e58
commit 308c3a1
Show file tree

Hide file tree

Showing 33 changed files with 118 additions and 68 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,10 @@
 
 ## Unreleased: pdoc next
 
-- Remove support for Python 3.8, which has reached end-of-life on 2024-10-07 .
+- Remove support for Python 3.8, which has reached end-of-life on 2024-10-07.
   ([#747](https://github.com/mitmproxy/pdoc/pull/747), @mhils)
+- Python 3.13: `@deprecated` decorators are now rendered with visual emphasis.
+  ([#750](https://github.com/mitmproxy/pdoc/pull/750), @mhils)
 - Inherited members are now hidden by default if the base class is not part of the documentation.
   Please make yourself heard in https://github.com/mitmproxy/pdoc/issues/715 if you relied on the old behavior.
   ([#748](https://github.com/mitmproxy/pdoc/pull/748), @mhils)

diff --git a/pdoc/templates/content.css b/pdoc/templates/content.css
@@ -308,6 +308,13 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
     margin-left: 2rem;
 }
 
+.pdoc .decorator-deprecated {
+    color: #842029;
+}
+.pdoc .decorator-deprecated ~ span {
+    filter: grayscale(1) opacity(0.8);
+}
+
 .pdoc .name {
     color: var(--name);
     font-weight: bold;

diff --git a/pdoc/templates/default/module.html.jinja2 b/pdoc/templates/default/module.html.jinja2
@@ -162,7 +162,7 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
 {% enddefaultmacro %}
 {% defaultmacro decorators(doc) %}
     {% for d in doc.decorators if not d.startswith("@_") %}
-        <div class="decorator">{{ d }}</div>
+        <div class="decorator decorator-{{ d[1:].partition("(")[0] }}">{{ d }}</div>
     {% endfor %}
 {% enddefaultmacro %}
 {% defaultmacro function(fn) -%}

diff --git a/test/testdata/ast_parsing.html b/test/testdata/ast_parsing.html
diff --git a/test/testdata/collections_abc.html b/test/testdata/collections_abc.html
diff --git a/test/testdata/demo.html b/test/testdata/demo.html
diff --git a/test/testdata/demo_eager.html b/test/testdata/demo_eager.html
diff --git a/test/testdata/demo_long.html b/test/testdata/demo_long.html
diff --git a/test/testdata/demopackage.html b/test/testdata/demopackage.html
diff --git a/test/testdata/demopackage_dir.html b/test/testdata/demopackage_dir.html
diff --git a/test/testdata/enums.html b/test/testdata/enums.html
diff --git a/test/testdata/example_customtemplate.html b/test/testdata/example_customtemplate.html
diff --git a/test/testdata/example_darkmode.html b/test/testdata/example_darkmode.html
diff --git a/test/testdata/example_mkdocs.html b/test/testdata/example_mkdocs.html
diff --git a/test/testdata/flavors_google.html b/test/testdata/flavors_google.html
diff --git a/test/testdata/flavors_numpy.html b/test/testdata/flavors_numpy.html
diff --git a/test/testdata/flavors_rst.html b/test/testdata/flavors_rst.html
diff --git a/test/testdata/math_demo.html b/test/testdata/math_demo.html
diff --git a/test/testdata/math_misc.html b/test/testdata/math_misc.html
diff --git a/test/testdata/mermaid_demo.html b/test/testdata/mermaid_demo.html
diff --git a/test/testdata/misc.html b/test/testdata/misc.html
diff --git a/test/testdata/misc_py310.html b/test/testdata/misc_py310.html
diff --git a/test/testdata/misc_py312.html b/test/testdata/misc_py312.html
diff --git a/test/testdata/misc_py313.html b/test/testdata/misc_py313.html
diff --git a/test/testdata/misc_py313.py b/test/testdata/misc_py313.py
@@ -1,6 +1,14 @@
+from warnings import deprecated
+
+
 class MyDict(dict):
     pass
 
 
 class CustomException(RuntimeError):
     """custom exception type"""
+
+
+@deprecated("Do not use this anymore")
+def deprecated_func():
+    pass
diff --git a/test/testdata/misc_py313.txt b/test/testdata/misc_py313.txt
@@ -18,4 +18,5 @@
         <method def add_note(self, object, /): ...  # inherited from builtins.BaseException.add_note, Exception.add_note(n…>
         <var args  # inherited from builtins.BaseException.args>
     >
+    <@deprecated('Do not use this anymore') function def deprecated_func(): ...>
 >
diff --git a/test/testdata/pyo3_sample_library.html b/test/testdata/pyo3_sample_library.html
diff --git a/test/testdata/render_options.html b/test/testdata/render_options.html
diff --git a/test/testdata/top_level_reimports.html b/test/testdata/top_level_reimports.html
diff --git a/test/testdata/type_checking_imports.html b/test/testdata/type_checking_imports.html
diff --git a/test/testdata/type_stubs.html b/test/testdata/type_stubs.html
diff --git a/test/testdata/typed_dict.html b/test/testdata/typed_dict.html
diff --git a/test/testdata/visibility.html b/test/testdata/visibility.html