{{cookiecutter.task_module}}.{{cookiecutter.task_class}}.rst.jinja

.. lsst-task-topic:: {{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}

{{ "#" * (cookiecutter.task_class|length) }}
{{ cookiecutter.task_class }}
{{ "#" * (cookiecutter.task_class|length) }}

.. Summary paragraph (a few sentences)
.. The aim is to say what the task is for

``{{ cookiecutter.task_class }}`` [active tense verb] ...
.. If the task consumes or creates datasets, name those datasets here.
.. If there are many datasets, name the ones that people use more frequently.

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class}}-summary:

Processing summary
==================

.. If the task does not break work down into multiple steps, don't use a list.
.. Instead, summarize the computation itself in a paragraph or two.

``{{ cookiecutter.task_class }}`` runs this sequence of operations:

#. Runs this thing. (FIXME)

#. Processes processes that intermediate result. (FIXME)

#. Stores those results in this last step. (FIXME)

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}-api:

Python API summary
==================

.. lsst-task-api-summary:: {{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}-subtasks:

Retargetable subtasks
=====================

.. lsst-task-config-subtasks:: {{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}-configs:

Configuration fields
====================

.. lsst-task-config-fields:: {{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}-examples:

Examples
========

.. Add a brief example here.
.. If there are multiple examples
.. (such as one from a command-line context and another that uses the Python API)
.. you can separate each example into a different subsection for clarity.

.. _{{ cookiecutter.task_module }}.{{ cookiecutter.task_class }}-debug:

Debugging
=========

.. If the task provides debug variables document them here using a definition list.