Skip to content

Commit

Permalink
Add basic .md.in for mcviewtest doc
Browse files Browse the repository at this point in the history
  • Loading branch information
willend committed Aug 5, 2024
1 parent b0fec03 commit c83b505
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
59 changes: 59 additions & 0 deletions tools/Python/mctest/mcviewtest.md.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
% @MCCODE_PREFIX@TEST(1)
% @FLAVOR_UPPER@ @MCCODE_PARTICLE@ Ray Tracing Team
% @MCCODE_DATE@

# NAME

**@MCCODE_PREFIX@viewtest** - View results from one or more runs of
the @MCCODE_PREFIX@test toool, testing the @MCCODE_NAME@ installation

# SYNOPSIS

**@MCCODE_PREFIX@viewtest** [-h] [--reflabel [REFLABEL]] [--testroot [TESTROOT]] [--verbose] [--nobrowse] [testdir]

# DESCRIPTION

The tool **@MCCODE_PREFIX@viewtest** is a program visualise testesults
from the current @MCCODE_NAME@ installation.

# OPTIONS

**-h, --help**
: show this help message and exit

**--reflabel REFLABEL**
Reference label name for comparison between
multiple test runs (oldest subfolder in PWD is
used if unset)

**--testroot [TESTROOT]**
test root folder for test result management

**--verbose**
output excessive information for debug purposes

**--nobrowse**
Do not spawn browser on exit

**testdir**
Indicate location of result directories
(PWD is used if unset)

# FILES

/usr/share/@FLAVOR@/resources
/usr/share/@FLAVOR@/tools/Python/mccodelib/mccode_config.json
~/.@FLAVOR@/mccode_config.json
http://www.@[email protected]

# EXAMPLES

`@MCCODE_PREFIX@viewtest`

# AUTHORS

@MCCODE_NAME@ Team (@[email protected])

# SEE ALSO

@FLAVOR@(1), @MCCODE_PREFIX@test(1), @MCCODE_PREFIX@doc(1), @MCCODE_PREFIX@plot(1), @MCCODE_PREFIX@run(1), @MCCODE_PREFIX@gui(1), @MCCODE_PREFIX@display(1)
2 changes: 1 addition & 1 deletion tools/Python/mctest/mcviewtest.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def main(args):
if __name__ == '__main__':
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('testdir', nargs="?", help='test data is drawn from this root folder')
parser.add_argument('--reflabel', nargs="?", help='reference label name')
parser.add_argument('--reflabel', nargs="?", help='Reference label name for comparison between multiple test runs (oldest subfolder in PWD is used if unset)')
parser.add_argument('--testroot', nargs="?", help='test root folder for test result management')
parser.add_argument('--verbose', action='store_true', help='output excessive information for debug purposes')
parser.add_argument('--nobrowse', action='store_true', help='Do not spawn browser on exit')
Expand Down

0 comments on commit c83b505

Please sign in to comment.