Update formatting and RST links

lsst · Mar 6, 2023 · 7de97f7 · 7de97f7
1 parent c1030e5
commit 7de97f7
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 33 deletions.
diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernalSpatialTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernalSpatialTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.ip.diffim.DecorrelateALKernelSpatialTask
 
-##########################
+##############################
 DecorrelateALKernelSpatialTask
-##########################
+##############################
 
 Pipe-task that removes the neighboring-pixel covariance in an
 image difference that are added when the template image is
@@ -11,20 +11,20 @@ convolved with the Alard-Lupton PSF matching kernel.
 .. _lsst.ip.diffim.DecorrelateALKernelSpatialTask-description:
 
 Description
-==================
+===========
 
-This task is a simple wrapper around @ref DecorrelateALKernelTask,
+This task is a simple wrapper around ~lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask,
 which takes a `spatiallyVarying` parameter in its `run` method. If
-it is `False`, then it simply calls the `run` method of @ref
-DecorrelateALKernelTask. If it is True, then it uses the @ref
-ImageMapReduceTask framework to break the exposures into
-subExposures on a grid, and performs the `run` method of @ref
-DecorrelateALKernelTask on each subExposure. This enables it to
+it is `False`, then it simply calls the `run` method of
+~lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask. If it is True, then it uses the
+~lsst.ip.diffim.imageDecorrelation.ImageMapReduceTask framework to break the exposures into
+subExposures on a grid, and performs the `run` method of
+~lsst.ip.diffim.imageDecorrelation.DecorrelateALKernelTask on each subExposure. This enables it to
 account for spatially-varying PSFs and noise in the exposures when
 performing the decorrelation.
 
 This task has no standalone example, however it is applied as a
-subtask of pipe.tasks.imageDifference.ImageDifferenceTask.
+subtask of ~pipe.tasks.imageDifference.ImageDifferenceTask.
 There is also an example of its use in `tests/testImageDecorrelation.py`.
 
 .. _lsst.ip.diffim.DecorrelateALKernelSpatialTask-api:

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernelTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DecorrelateALKernelTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.ip.diffim.DecorrelateALKernelTask
 
-##########################
+#######################
 DecorrelateALKernelTask
-##########################
+#######################
 
 Pipe-task that removes the neighboring-pixel covariance in an
 image difference that are added when the template image is
@@ -11,11 +11,10 @@ convolved with the Alard-Lupton PSF matching kernel.
 .. _lsst.ip.diffim.DecorrelateALKernelTask-description:
 
 Description
-==================
+===========
 
-The image differencing pipeline task @link
-ip.diffim.psfMatch.PsfMatchTask PSFMatchTask@endlink and @link
-ip.diffim.psfMatch.PsfMatchConfigAL PSFMatchConfigAL@endlink uses
+The image differencing pipeline task ~ip.diffim.psfMatch.PsfMatchTask and
+~ip.diffim.psfMatch.PsfMatchConfigAL uses
 the Alard and Lupton (1998) method for matching the PSFs of the
 template and science exposures prior to subtraction. The
 Alard-Lupton method identifies a matching kernel, which is then
@@ -32,7 +31,7 @@ convolving the image difference with it. This process is described
 in detail in [DMTN-021](http://dmtn-021.lsst.io).
 
 This task has no standalone example, however it is applied as a
-subtask of pipe.tasks.imageDifference.ImageDifferenceTask.
+subtask of ~pipe.tasks.imageDifference.ImageDifferenceTask.
 
 .. _lsst.ip.diffim.DecorrelateALKernelTask-api:
 

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DiaCatalogSourceSelectorTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DiaCatalogSourceSelectorTask.rst
@@ -1,15 +1,15 @@
 .. lsst-task-topic:: lsst.ip.diffim.DiaCatalogSourceSelectorTask
 
-##########################
+############################
 DiaCatalogSourceSelectorTask
-##########################
+############################
 
 A task that selects sources for Kernel candidates.
 
 .. _lsst.ip.diffim.DiaCatalogSourceSelectorTask-description:
 
 Description
-==================
+===========
 
 A naive star selector based on second moments. Use with caution.
 
@@ -39,7 +39,10 @@ Configuration fields
 Debugging
 =========
 
-DiaCatalogSourceSelectorTask has a debug dictionary with the following keys:
+The ``pipetask`` command line interface supports a ``--debug`` flag to import
+``debug.py`` from your PYTHONPATH; see :ref:`lsstDebug` for more about ``debug.py``
+files.
+The available variables in DiaCatalogSourceSelectorTask include:
 
 display : `bool`
     if True display debug information

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DipoleMeasurementTask.rst
@@ -1,18 +1,18 @@
 .. lsst-task-topic:: lsst.ip.diffim.DipoleMeasurementTask
 
-##########################
+#####################
 DipoleMeasurementTask
-##########################
+#####################
 
 DipoleMeasurementTask measures sources on images to identify likely dipoles.
 This task is purely a configuration wrapper around `~lsst.meas.base.SingleFrameMeasurementTask`, with helpers to performe dipole-specific measurements.
 
 .. _lsst.ip.diffim.DipoleMeasurementTask-description:
 
 Description
-==================
+===========
 
-These plugins enabled by default allow the user to test the hypothesis that the
+The plugins used by this task by default allow the user to test the hypothesis that the
 Source is a dipole. This includes a set of measurements derived from
 intermediate base classes DipoleCentroidAlgorithm and DipoleFluxAlgorithm.
 Their respective algorithm control classes are defined in

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.GetCoaddAsTemplateTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.GetCoaddAsTemplateTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.ip.diffim.GetCoaddAsTemplateTask
 
-##########################
+######################
 GetCoaddAsTemplateTask
-##########################
+######################
 
 From the given skymap, the closest tract is selected; multiple tracts are
 not supported. The assembled template inherits the WCS of the selected

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.ImagePsfMatchTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.ImagePsfMatchTask.rst
@@ -1,15 +1,15 @@
 .. lsst-task-topic:: lsst.ip.diffim.ImagePsfMatchTask
 
-##########################
+#################
 ImagePsfMatchTask
-##########################
+#################
 
 ImagePsfMatchTask creates a PSF-matching kernel for two images.
 
 .. _lsst.ip.diffim.ImagePsfMatchTask-description:
 
 Description
-==================
+===========
 
 Build a Psf-matching kernel using two input images, either as MaskedImages
 (in which case they need to be astrometrically aligned) or Exposures (in which

diff --git a/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.ModelPsfMatchTask.rst b/doc/lsst.ip.diffim/tasks/lsst.ip.diffim.ModelPsfMatchTask.rst
@@ -1,8 +1,8 @@
 .. lsst-task-topic:: lsst.ip.diffim.ModelPsfMatchTask
 
-##########################
+#################
 ModelPsfMatchTask
-##########################
+#################
 
 ImagePsfMatchTask creates a PSF-matching kernel for two models.
 
@@ -63,7 +63,7 @@ Debugging
 =========
 
 The ``pipetask`` command line interface supports a flag ``--debug`` to import
-ref:  supports a flag ``--debug`` to import debug.py from your PYTHONPATH;
+import debug.py from your PYTHONPATH;
 see :ref:`lsstDebug` for more about debug.py files.
 The available variables in ModelsPsfMatchTask include: