Skip to content
Snippets Groups Projects
Commit c9fa6d17 authored by Hans Fangohr's avatar Hans Fangohr
Browse files

improve documentation

parent 16cdf534
No related branches found
No related tags found
1 merge request!61get rid of `--toolchain` flag
......@@ -26,13 +26,41 @@ else:
rich_available = True
about_tool = """
about_intro = f"""
Build toolchains using Spack.\n
This function builds toolchains for MPSD-HPC at the appropriate directory, \n
for given system architecture and MPSD software stack version.\n
The toolchains
are built using the bash script spack_setup.sh, and the results are logged. """
This function builds toolchains for MPSD-HPC at the appropriate directory,
for given system architecture and MPSD software stack version. The toolchains
are built using the bash script spack_setup.sh, and the results are logged.
Command line usage:
$> {sys.argv[0]}
"""
about_epilog = f"""
Examples:
1. Query what package sets and toolchains are available in relase dev-23a
$> {sys.argv[0]} available dev-23a
2. Install foss2022a-serial toolchain
$> {sys.argv[0]} install dev-23a foss2022a-serial
3. Check what package sets and toolchains are installed from release dev-23a
$> {sys.argv[0]} status dev-23a
Documentation: https://gitlab.gwdg.de/mpsd-cs/mpsd-software/-/blob/main/README.rst
"""
call_date_iso = (
datetime.datetime.now().replace(microsecond=0).isoformat().replace(":", "-")
......@@ -1032,7 +1060,8 @@ def environment_status(mpsd_release: str, root_dir: Union[str, Path]) -> dict:
def main():
"""Execute main entry point."""
parser = argparse.ArgumentParser(description=about_tool)
parser = argparse.ArgumentParser(description=about_intro, epilog=about_epilog,
formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument(
"--log",
"-l",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment