Construcción de documentación de API¶
0.15.0 < 0.16.0
mkdocstrings¶
Puedes traducir tus cadenas de documentación usando mkdocstrings con mdpo.
Precaución
- Empezando en v0.16.0 el plugin funciona pero los nombres de parámetros de función y sus tipos son añadidos también al archivo PO como
msgid "**value:** `str` – Value to check.".
mkdocs_mdpo_plugin.docs_helper.function¶
Documentación de función.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value |
str |
Valor a comprobar. |
required |
mkdocs_mdpo_plugin.docs_helper.other_function¶
Documentación de otra función.
Returns:
| Type | Description |
|---|---|
str |
Valor de retorno. |
### **`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`**"