mkdocstrings-python 1.12.0__tar.gz → 1.12.2__tar.gz

{mkdocstrings_python-1.12.0 → mkdocstrings_python-1.12.2}/CHANGELOG.md

@@ -5,6 +5,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.12.2](https://github.com/mkdocstrings/python/releases/tag/1.12.2) - 2024-10-19
+
+<small>[Compare with 1.12.1](https://github.com/mkdocstrings/python/compare/1.12.1...1.12.2)</small>
+
+### Bug Fixes
+
+- Always render cross-references outside of signatures ([73f11dc](https://github.com/mkdocstrings/python/commit/73f11dcc584a672af7e17738cba08a50f119176a) by Timothée Mazzucotelli). [Issue-mkdocstrings#700](https://github.com/mkdocstrings/mkdocstrings/issues/700)
+
+## [1.12.1](https://github.com/mkdocstrings/python/releases/tag/1.12.1) - 2024-10-14
+
+<small>[Compare with 1.12.0](https://github.com/mkdocstrings/python/compare/1.12.0...1.12.1)</small>
+
+### Bug Fixes
+
+- Don't escape parameter default values ([9dee4d4](https://github.com/mkdocstrings/python/commit/9dee4d4f8e1258e99c19dc7b2b18d3e9090de79b) by Timothée Mazzucotelli). [Issue-191](https://github.com/mkdocstrings/python/issues/191)
+
 ## [1.12.0](https://github.com/mkdocstrings/python/releases/tag/1.12.0) - 2024-10-12
 
 <small>[Compare with 1.11.1](https://github.com/mkdocstrings/python/compare/1.11.1...1.12.0)</small>

{mkdocstrings_python-1.12.0 → mkdocstrings_python-1.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.12.0
+Version: 1.12.2
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC

{mkdocstrings_python-1.12.0 → mkdocstrings_python-1.12.2}/pyproject.toml

@@ -37,7 +37,7 @@ dependencies = [
     "mkdocs-autorefs>=1.2",
     "griffe>=0.49",
 ]
-version = "1.12.0"
+version = "1.12.2"
 
 [project.license]
 text = "ISC"

{mkdocstrings_python-1.12.0 → mkdocstrings_python-1.12.2}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja

@@ -32,15 +32,16 @@ which is a tree-like structure representing a Python expression.
       {%- set annotation = full -%}
     {%- endif -%}
     {%- for title, path in annotation|split_path(full) -%}
-      {%- if config.signature_crossrefs -%}
-        {%- if signature -%}
-          {%- filter stash_crossref(length=title|length) -%}
-            <autoref identifier="{{ path }}" optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
-          {%- endfilter -%}
-        {%- else -%}
+      {%- if not signature -%}
+        {#- Always render cross-references outside of signatures. We don't need to stash them. -#}
+        <autoref identifier="{{ path }}" optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
+      {%- elif config.signature_crossrefs -%}
+        {#- We're in a signature and cross-references are enabled, we must render one and stash it. -#}
+        {%- filter stash_crossref(length=title|length) -%}
           <autoref identifier="{{ path }}" optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
-        {%- endif -%}
+        {%- endfilter -%}
       {%- else -%}
+        {#- We're in a signature but cross-references are disabled, we just render the title. -#}
         {{ title }}
       {%- endif -%}
       {%- if not loop.last -%}.{%- endif -%}

{mkdocstrings_python-1.12.0 → mkdocstrings_python-1.12.2}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja

@@ -106,7 +106,7 @@ Context:
               {%- include "expression"|get_template with context -%}
             {%- endwith -%}
           {%- else -%}
-            {{ parameter.default }}
+            {{ parameter.default|safe }}
           {%- endif -%}
         {%- endif -%}