Skip to content

Latest commit

 

History

History

script_topic

script_topic

Documentation topic template for creating reference pages about scripts.

This documentation topic template is intended to work with any script and relies on manual documentation of a script's options and arguments. If the script is built with argparse, use the argparse_script_topic template instead to take advantage of automatic documentation tooling.

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 runPipeline.sh is documented in a file called runPipeline.sh.rst.

More documentation is available in the DM Developer Guide.

Template variables

cookiecutter.script_name

The name of the command-line executable. For example: runPipeline.sh.

Examples

exampleScript.sh.rst

exampleScript.sh.rst is an example of a script topic for a shell script named exampleScript.sh.

Related templates