Tidy up formatting

lsst · Apr 28, 2023 · 3d251ae · 3d251ae
1 parent e12104d
commit 3d251ae
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 41 deletions.
diff --git a/doc/lsst.analysis.tools/action-types.rst b/doc/lsst.analysis.tools/action-types.rst
@@ -2,7 +2,7 @@
 Action Types
 ============
 
-Here is a list of the current actions implemented in ``analysis tools``, please look at these carefully before
+Here is a list of the current actions implemented in ``analysis_tools``, please look at these carefully before
 adding new actions to avoid duplication.
 
 Plot actions are covered in a separate :doc:`section <plot-types>`.
@@ -12,21 +12,9 @@ Vector Actions
 
 .. automodapi:: lsst.analysis.tools.actions.vector
     :no-inherited-members:
-    :skip: ConfigurableActionField
-    :skip: ConfigurableActionStructField
-    :skip: DictField
-    :skip: Field
-    :skip: Vector
-    :skip: VectorAction
 
 Scalar Actions
 ==============
 
 .. automodapi:: lsst.analysis.tools.actions.scalar
     :no-inherited-members:
-    :skip: ChoiceField
-    :skip: Field
-    :skip: Scalar
-    :skip: ScalarAction
-    :skip: Vector
-
diff --git a/doc/lsst.analysis.tools/index.rst b/doc/lsst.analysis.tools/index.rst
@@ -15,15 +15,19 @@ It is a very powerful way to explore and interact with the pipeline outputs.
 
 Using lsst.analysis.tools
 =========================
+
 For a tutorial on working with
 ``analysis_tools`` please see the :ref:`getting started guide <analysis-tools-getting-started>`.
 
 .. toctree linking to topics related to using the module's APIs.
 
-.. .. toctree::
-..   :glob:
-..   currentActions
-..   currentPlots
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   getting-started
+   action-types
+   plot-types
 
 Need Help?
 ==========
@@ -37,7 +41,6 @@ channel on slack and hopefully someone will help you!
 Contributing
 ============
 
-
 ``lsst.analysis.tools`` is developed at https://github.com/lsst/analysis_tools.
 You can find Jira issues for this module under the `analysis_tools <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20analysis_tools>`_ component.
 

diff --git a/doc/lsst.analysis.tools/plot-types.rst b/doc/lsst.analysis.tools/plot-types.rst
@@ -1,11 +1,15 @@
+##########
 Plot Types
-==========
-Details of current plot types are here, these plots are all in ``python/lsst/analysis/tools/actions/plot`` and
-can all be found on `github <https://github.com/lsst/analysis_tools/blob/main/python/lsst/analysis/tools/actions/plot/>`__.
+##########
+
+This page lists the plot types provided by ``analysis_tools``.
+The modules for these plots are all in ``python/lsst/analysis/tools/actions/plot`` and
+can all be found on `GitHub <https://github.com/lsst/analysis_tools/blob/main/python/lsst/analysis/tools/actions/plot/>`__.
 
 
 .. automodapi:: lsst.analysis.tools.actions.plot
    :no-inherited-members:
+   :noindex:
    :skip: BarPanel
    :skip: DiaSkyPanel
    :skip: HistPanel

diff --git a/python/lsst/analysis/tools/actions/plot/barPlots.py b/python/lsst/analysis/tools/actions/plot/barPlots.py
@@ -93,21 +93,21 @@ def makePlot(
             An optional dictionary of information about the data being
             plotted with keys:
             `"run"`
-            Output run for the plots (`str`).
+                Output run for the plots (`str`).
             `"tractTableType"`
-            Table from which results are taken (`str`).
+                Table from which results are taken (`str`).
             `"plotName"`
-            Output plot name (`str`)
+                Output plot name (`str`)
             `"SN"`
-            The global signal-to-noise data threshold (`float`)
+                The global signal-to-noise data threshold (`float`)
             `"skymap"`
-            The type of skymap used for the data (`str`).
+                The type of skymap used for the data (`str`).
             `"tract"`
-            The tract that the data comes from (`int`).
+                The tract that the data comes from (`int`).
             `"bands"`
-            The bands used for this data (`str` or `list`).
+                The bands used for this data (`str` or `list`).
             `"visit"`
-            The visit that the data comes from (`int`)
+                The visit that the data comes from (`int`)
 
         Returns
         -------

diff --git a/python/lsst/analysis/tools/actions/plot/histPlot.py b/python/lsst/analysis/tools/actions/plot/histPlot.py
@@ -57,19 +57,17 @@ class HistStatsPanel(Config):
     customize the HistPlot stats panel.
 
     - The ListField parameter a dict to specify names of 3 stat columns accepts
-    latex formating
+      latex formating
 
     - The other parameters (stat1, stat2, stat3) are lists of strings that
-    specify vector keys correspoinding to scalar values computed in the
-    prep/process/produce steps of an analysis tools plot/metric configurable
-    action. There should be one key for each group in the HistPanel.
+      specify vector keys correspoinding to scalar values computed in the
+      prep/process/produce steps of an analysis tools plot/metric configurable
+      action. There should be one key for each group in the HistPanel.
 
     A separate config class is used instead of constructing
     `~lsst.pex.config.DictField`'s in HistPanel for each parameter for clarity
     and consistency.
 
-
-
     Notes
     -----
     This is intended to be used as a configuration of the HistPlot/HistPanel

diff --git a/python/lsst/analysis/tools/actions/plot/multiVisitCoveragePlot.py b/python/lsst/analysis/tools/actions/plot/multiVisitCoveragePlot.py
@@ -253,9 +253,9 @@ def makePlot(
             A dictionary of information about the data being plotted with (at
             least) keys:
             `"run"`
-            Output run for the plots (`str`).
+                Output run for the plots (`str`).
             `"tableName"`
-            Name of the table from which results are taken (`str`).
+                Name of the table from which results are taken (`str`).
         camera : `lsst.afw.cameraGeom.Camera`, optional
             The camera object associated with the data. This is to enable the
             conversion of to focal plane coordinates (if needed, i.e. for the

diff --git a/python/lsst/analysis/tools/actions/plot/skyPlot.py b/python/lsst/analysis/tools/actions/plot/skyPlot.py
@@ -151,13 +151,13 @@ def makePlot(
         plotInfo : `dict`
             A dictionary of information about the data being plotted with keys:
             ``"run"``
-            The output run for the plots (`str`).
+                The output run for the plots (`str`).
             ``"skymap"``
-            The type of skymap used for the data (`str`).
+                The type of skymap used for the data (`str`).
             ``"filter"``
-            The filter used for this data (`str`).
+                The filter used for this data (`str`).
             ``"tract"``
-            The tract that the data comes from (`str`).
+                The tract that the data comes from (`str`).
         sumStats : `dict`
             A dictionary where the patchIds are the keys which store the R.A.
             and dec of the corners of the patch.