fixup! feat: add parameters defaults to RTD

mkdocstrings · Jul 24, 2023 · c1b44d3 · c1b44d3
1 parent 42f6b8a
commit c1b44d3
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 21 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,21 +53,18 @@
         <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 %}
         –
         <div class="doc-md-description">
           {{ parameter.description|convert_markdown(heading_level, html_id) }}
         </div>
-        {% if parameter.default %}
-          <p>
-            <b>{{ lang.t("Default:") }}</b>
-            {% with expression = parameter.default %}
-              <code>{% include "expression.html" with context %}</code>
-            {% endwith %}
-          </p>
-        {% endif %}
       </li>
     {% endfor %}
   </ul>

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,21 +17,18 @@
               <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 %}
               –
               <div class="doc-md-description">
                 {{ parameter.description|convert_markdown(heading_level, html_id) }}
               </div>
-              {% if parameter.default %}
-              <p>
-                <b>{{ lang.t("Default:") }}</b>
-                {% with expression = parameter.default %}
-                  <code>{% include "expression.html" with context %}</code>
-                {% endwith %}
-              </p>
-            {% endif %}
             </li>
           {% endfor %}
         </ul>

diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html
@@ -3,7 +3,7 @@
     "Attributes:": "Attributes:",
     "Other parameters:": "Other parameters:",
     "Parameters:": "Parameters:",
-    "Default": "Default",
+    "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,7 +3,7 @@
     "Attributes:": "属性：",
     "Other Parameters:": "他の引数：",
     "Parameters:": "引数：",
-    "Default": "デフォルト",
+    "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,7 +3,7 @@
     "Attributes:": "属性：",
     "Other Parameters:": "其他参数：",
     "Parameters:": "参数：",
-    "Default": "默认",
+    "default:": "默认：",
     "Raises:" : "引发：",
     "Receives:": "接收：",
     "Returns:": "返回：",