buildtest.tools.docs

Module Contents

Functions

run(query)	This method will execute command for the tutorials examples. If returncode
write_example(fname, command)	Given a shell command, we will write output to file. We will print first
build_spack_examples(autogen_dir)	This method will build spack examples for the tutorial
build_compiler_examples(autogen_dir)	This method will build examples for compiler examples for the tutorial

buildtest.tools.docs.run(query)

This method will execute command for the tutorials examples. If returncode is non-zero we raise exception otherwise we return output of command.

Parameters

query (str) – Run a arbitrary shell command.

buildtest.tools.docs.write_example(fname, command)

Given a shell command, we will write output to file. We will print first 10 lines from upon writing file to ensure file was written properly.

Parameters

• fname (str) – Path to file where output of command will be written

• command (str) – Command that was executed

buildtest.tools.docs.build_spack_examples(autogen_dir)

This method will build spack examples for the tutorial

Parameters

autogen_dir (str) – Directory where auto generated documentation examples will be written.

buildtest.tools.docs.build_compiler_examples(autogen_dir)

This method will build examples for compiler examples for the tutorial

Parameters

autogen_dir (str) – Directory where auto generated documentation examples will be written.