Merge pull request #721 from lsst/tickets/DM-35939

DM-35939: Convert pipe_tasks to numpydoc and task topics

doc/lsst.pipe.tasks/index.rst

@@ -73,8 +73,197 @@ Python API reference
 ====================
 
 .. automodapi:: lsst.pipe.tasks.assembleCoadd
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.associationUtils
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.background
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.calexpCutout
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.calibrate
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.characterizeImage
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.coaddBase
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.coaddInputRecorder
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.colorterms
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.computeExposureSummaryStats
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.cosmicRayPostDiff
+   :no-inheritance-diagram:
+
 .. automodapi:: lsst.pipe.tasks.dcrAssembleCoadd
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.deblendCoaddSourcesPipeline
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.diff_matched_tract_catalog
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.drpAssociationPipe
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.drpDiaCalculationPipe
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.exampleStatsTasks
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.extended_psf
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.fakes
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.finalizeCharacterization
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.fit_multiband
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.functors
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.healSparseMapping
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.healSparseMappingProperties
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.hips
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.insertFakes
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.interpImage
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.isolatedStarAssociation
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.loadReferenceCatalog
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.makeCoaddTempExp
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.makeDiscreteSkyMap
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.makeWarp
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.maskStreaks
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.matchBackgrounds
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.matchFakes
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.match_tract_catalog
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.match_tract_catalog_probabilistic
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.measurePsf
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.mergeDetections
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.mergeMeasurements
+   :no-inheritance-diagram:
 
 .. automodapi:: lsst.pipe.tasks.metrics
-   :no-main-docstr:
    :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.multiBand
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.multiBandUtils
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.objectMasks
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.parquetTable
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.photoCal
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.postprocess
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.processBrightStars
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.processCcdWithFakes
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.propagateSourceFlags
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.propagateVisitFlags
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.quickFrameMeasurement
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.read_curated_calibs
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.registerImage
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.repair
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.reserveIsolatedStars
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.scaleZeroPoint
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.selectImages
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.setPrimaryFlags
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.simpleAssociation
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.skyCorrection
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.snapCombine
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.statistic
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.visualizeVisit
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.pipe.tasks.warpAndPsfMatch
+   :no-inheritance-diagram:
+

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.healSparseMapping.ConsolidateHealSparsePropertyMapTask.rst

@@ -20,7 +20,7 @@ Python API summary
 
 .. lsst-task-api-summary:: lsst.pipe.tasks.healSparseMapping.ConsolidateHealSparsePropertyMapTask
 
-.. _lsst.pipe.tasks.healSparseMapping.ConsolidateHealSparsePropertyMapTask-subtasks:
+.. _lsst.pipe.tasks.healSparseMapping.ConsolidateHealSparsePropertyMapTask-config:
 
 Configuration fields
 ====================

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.rst

@@ -18,7 +18,7 @@ Retargetable subtasks
 
 .. lsst-task-config-subtasks:: lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask
 
-.. _lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask-fields:
+.. _lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask-config:
 
 Configuration fields
 ====================

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.healSparseMapping.HealSparsePropertyMapTask.rst

@@ -20,7 +20,7 @@ Truncation to the inner region is performed when tract maps are consoldated in :
 
 Supported Map Types
 ===================
-The following map types are supported, and it is possible to add more by subclassing ``lsst.pipe.tasks.healSparseMappingProperties.BasePropertyMap``.
+The following map types are supported, and it is possible to add more by subclassing `~lsst.pipe.tasks.healSparseMappingProperties.BasePropertyMap`.
 All values are sampled at the center of each map pixel.
 All PSF properties are estimated by realizing the PSF model over a grid of points on each detector and approximating the variation with a second-order Chebyshev polynomial.
 
@@ -51,7 +51,7 @@ Retargetable subtasks
 
 .. lsst-task-config-subtasks:: lsst.pipe.tasks.healSparseMapping.HealSparsePropertyMapTask
 
-.. _lsst.pipe.tasks.healSparseMapping.HealSparsePropertyMapTask-fields:
+.. _lsst.pipe.tasks.healSparseMapping.HealSparsePropertyMapTask-config:
 
 Configuration fields
 ====================

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.interpImage.InterpImageTask.rst

@@ -18,7 +18,7 @@ Retargetable subtasks
 
 .. lsst-task-config-subtasks:: lsst.pipe.tasks.interpImage.InterpImageTask
 
-.. _lsst.pipe.tasks.interpImage.InterpImageTask-fields:
+.. _lsst.pipe.tasks.interpImage.InterpImageTask-config:
 
 Configuration fields
 ====================

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.rst

@@ -54,3 +54,16 @@ Output datasets
 
 ``visitSummary``
     Per-visit summary catalog of ccd/visit metadata.
+
+.. _lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask-subtasks:
+
+Examples
+========
+
+The following command shows an example of how to run the task on an example HSC repository.
+
+.. code-block:: bash
+
+    consolidateVisitSummary.py /datasets/hsc/repo --rerun <rerun name> --id visit=30504
+
+.. _lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask-debug:

doc/lsst.pipe.tasks/tasks/lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask.rst

@@ -4,16 +4,22 @@
 PsfWcsSelectImagesTask
 ######################
 
+.. _lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask-api:
+
 Python API summary
 ==================
 
 .. lsst-task-api-summary:: lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask
 
+.. _lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask-subtasks:
+
 Retargetable subtasks
 =====================
 
 .. lsst-task-config-subtasks:: lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask
 
+.. _lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask-configs:
+
 Configuration fields
 ====================