API documentation building¶
0.15.0 < 0.16.0
mkdocstrings¶
You can translate your docstrings using mkdocstrings with mdpo.
Warning
- Starting from v0.16.0 the plugin works but function parameters names and types are also added to the PO file as
msgid "**value:** `str` – Value to check.".
mkdocs_mdpo_plugin.docs_helper.function¶
Function documentation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value | str | Value to check. | required |
mkdocs_mdpo_plugin.docs_helper.other_function¶
Other function documentation.
Returns:
| Type | Description |
|---|---|
str | Return value. |
### **`mkdocs_mdpo_plugin.docs_helper.function`**
::: mkdocs_mdpo_plugin.docs_helper.function
### **`mkdocs_mdpo_plugin.docs_helper.other_function`**
::: mkdocs_mdpo_plugin.docs_helper.other_function
msgid "Function documentation."
msgstr "Documentación de función."
msgid "Value to check."
msgstr "Valor a comprobar."
msgid "**`mkdocs_mdpo_plugin.docs_helper.function`**"
msgstr "**`mkdocs_mdpo_plugin.docs_helper.function`**"
msgid "Other function documentation."
msgstr "Documentación de otra función."
msgid "Return value."
msgstr "Valor de retorno."
msgid "**`mkdocs_mdpo_plugin.docs_helper.other_function`**"
msgstr "**`mkdocs_mdpo_plugin.docs_helper.other_function`**"