Documentation topic template for creating reference pages about an argparse-based Python script.
This documentation topic template is intended to create reference pages for argparse-based Python scripts that are packaged with LSST software.
It takes advantage of tooling to automatically extract documentation about the command-line interface from the code itself.
For scripts that aren't built with argparse, use the more generic script_topic template instead.
Script topic pages go in the scripts/ subdirectory of the module documentation directory in the package that implements the task.
These script pages are referenced from the module documentation homepage.
The file itself is named after the executable script.
For example, a script called plotSkyMap.py is documented in a file called plotSkyMap.py.rst.
More documentation is available in the DM Developer Guide.
The Python module containing a function (called build_argparser by default) that generates the script's argparse.ArgumentParser instance.
For example: lsst.verify.bin.dispatchverify.
The name of the command-line executable.
For example: dispatch_verify.py.
exampleScript.py.rst is an example of a script topic for a argparse-based script named exampleScript.py that is implemented in a module called lsst.example.bin.examplescript.