Merge branch 'improve-documentation' into 'main'

just tried this, so we might as well document the behaviour

See merge request mpsd-cs/mpsd-software-environments!58

mpsd-software.py

@@ -729,6 +729,18 @@ def prepare_environment(mpsd_release: str, root_dir: Path) -> List[str]:
     -------
     available_toolchains : list
         A list of available toolchains for the given MPSD release.
+
+    Example
+    -------
+    >>> prepare_environment('dev-23a', Path('.'))
+    ['foss2021a-cuda-mpi',
+     'foss2021a-mpi',
+     'foss2021a-serial',
+     'foss2022a-cuda-mpi',
+     'foss2022a-mpi',
+     'foss2022a-serial',
+     'global',
+     'global_generic']
     """
     logging.info(f"Preparing {mpsd_release=}")