render the board support list within the docs of os.getenv

This commit is contained in:
Jeff Epler 2023-07-20 10:51:53 -05:00
parent 9593ec44b1
commit 6a2499227a
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE
1 changed files with 20 additions and 1 deletions

View File

@ -41,6 +41,8 @@
//| """functions that an OS normally provides
//|
//| |see_cpython_module| :mod:`cpython:os`.
//|
//| .. jinja
//| """
//|
//| import typing
@ -88,7 +90,24 @@ MP_DEFINE_CONST_FUN_OBJ_0(os_getcwd_obj, os_getcwd);
//| def getenv(key: str, default: Optional[str] = None) -> Optional[str]:
//| """Get the environment variable value for the given key or return ``default``.
//|
//| This may load values from disk so cache the result instead of calling this often."""
//| This may load values from disk so cache the result instead of calling this often.
//|
//| On boards that do not support ``settings.toml`` reading in the core, this function will raise NotImplementedError.
//|
//| .. raw:: html
//|
//| <p>
//| <details>
//| <summary>Available on these boards</summary>
//| <ul>
//| {% for board in support_matrix_reverse["os.getenv"] %}
//| <li> {{ board }}
//| {% endfor %}
//| </ul>
//| </details>
//| </p>
//|
//| """
//| ...
//|
STATIC mp_obj_t os_getenv(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {