feat: add parameters defaults to RTD

mkdocstrings · Jul 23, 2023 · 42f6b8a · 42f6b8a
1 parent f4aa4ea
commit 42f6b8a
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html
@@ -24,6 +24,14 @@
               <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,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:": "返回：",