feat: Show parameter default values within the "list" section style too

PR #92: #92 Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
mkdocstrings · Aug 6, 2023 · 55f08f3 · 55f08f3
1 parent b1651bb
commit 55f08f3
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 3 deletions.
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
@@ -53,7 +53,12 @@
         <b>{{ parameter.name }}</b>
         {% if parameter.annotation %}
           {% with expression = parameter.annotation %}
-            (<code>{% include "expression.html" with context %}</code>)
+            (<code>{% include "expression.html" with context %}</code>
+            {%- if parameter.default %}, {{ lang.t("default:") }}
+              {% with expression = parameter.default %}
+                <code>{% include "expression.html" with context %}</code>
+              {% endwith %}
+            {% endif %})
           {% endwith %}
         {% endif %}
         –
@@ -105,4 +110,4 @@
     </tbody>
   </table>
   {% endblock spacy_style %}
-{% endif %}
+{% endif %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html b/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html
@@ -4,6 +4,7 @@
     "Attributes:": "Attributes:",
     "DEFAULT:": "DEFAULT:",
     "Default": "Default",
+    "default:": "default:",
     "DESCRIPTION": "DESCRIPTION",
     "Description": "Description",
     "Examples:": "Examples:",

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html b/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html
@@ -4,6 +4,7 @@
   "Attributes:": "属性：",
   "DEFAULT:": "デフォルト：",
   "Default": "デフォルト",
+  "default:": "デフォルト：",
   "DESCRIPTION": "デスクリプション",
   "Description": "デスクリプション",
   "Examples:": "例：",

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html b/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html
@@ -4,6 +4,7 @@
     "Attributes:": "属性：",
     "DEFAULT:": "默认：",
     "Default": "默认",
+    "default:": "默认：",
     "DESCRIPTION": "描述",
     "Description": "描述",
     "Examples:": "示例：",

diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html
@@ -17,7 +17,12 @@
               <b>{{ parameter.name }}</b>
               {% if parameter.annotation %}
                 {% with expression = parameter.annotation %}
-                  (<code>{% include "expression.html" with context %}</code>)
+                  (<code>{% include "expression.html" with context %}</code>
+                  {%- if parameter.default %}, {{ lang.t("default:") }}
+                    {% with expression = parameter.default %}
+                      <code>{% include "expression.html" with context %}</code>
+                    {% endwith %}
+                  {% endif %})
                 {% endwith %}
               {% endif %}
               –

diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html
@@ -3,6 +3,7 @@
     "Attributes:": "Attributes:",
     "Other parameters:": "Other parameters:",
     "Parameters:": "Parameters:",
+    "default:": "default:",
     "Raises:" : "Raises:",
     "Receives:": "Receives:",
     "Returns:": "Returns:",

diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html
@@ -3,6 +3,7 @@
     "Attributes:": "属性：",
     "Other Parameters:": "他の引数：",
     "Parameters:": "引数：",
+    "default:": "デフォルト：",
     "Raises:" : "発生：",
     "Receives:": "取得：",
     "Returns:": "戻り値：",

diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html
@@ -3,6 +3,7 @@
     "Attributes:": "属性：",
     "Other Parameters:": "其他参数：",
     "Parameters:": "参数：",
+    "default:": "默认：",
     "Raises:" : "引发：",
     "Receives:": "接收：",
     "Returns:": "返回：",