Merge branch 'tickets/DM-23833'

lsst · Jun 5, 2020 · e319b44 · e319b44
2 parents 07d1145 + eaa527b
commit e319b44
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 28 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,33 +1,12 @@
-.. py:currentmodule:: lsst.cbp
+#########################
+cbp documentation preview
+#########################
 
-.. _lsst.cbp:
+.. This page is for local development only. It isn't published to pipelines.lsst.io.
 
-########
-lsst.cbp
-########
-
-The ``cbp`` package provides code for the LSST `collimated beam projector <https://arxiv.org/abs/1805.05867>`_ (CBP).
-The primary objects of interest are:
-
-`lsst.cbp.CoordinateConverter`: compute the telescope and CBP pointing that will give you a desired beam arrangement, such as placing beam *b* at point *p* on the pupil and point *d* on a specified detector.
-
-`lsst.cbp.computeHolePositions`: compute hole positions for a CBP mask.
-
-To construct an `lsst.cbp.CoordinateConverter` you will need to learn about configuration:
-
-.. toctree::
-
-    configuration
-
-In order to :ref:`configure <lsst.cbp.configuration>` and use an `lsst.cbp.CoordinateConverter` it may help to have some understanding of the coordinate systems involved:
+.. Link the index pages of package and module documentation directions (listed in manifest.yaml).
 
 .. toctree::
+   :maxdepth: 1
 
-    coordinateFrames
-
-Python API reference
-====================
-
-.. automodapi:: lsst.cbp
-.. automodapi:: lsst.cbp.coordUtils
-.. automodapi:: lsst.cbp.testUtils
+   lsst.cbp/index
diff --git a/doc/configuration.rst → doc/lsst.cbp/configuration.rst b/doc/configuration.rst → doc/lsst.cbp/configuration.rst
diff --git a/doc/coordinateFrames.rst → doc/lsst.cbp/coordinateFrames.rst b/doc/coordinateFrames.rst → doc/lsst.cbp/coordinateFrames.rst
diff --git a/doc/lsst.cbp/index.rst b/doc/lsst.cbp/index.rst
@@ -0,0 +1,41 @@
+.. py:currentmodule:: lsst.cbp
+
+.. _lsst.cbp:
+
+########
+lsst.cbp
+########
+
+The ``cbp`` package provides code for the LSST `collimated beam projector <https://arxiv.org/abs/1805.05867>`_ (CBP).
+The primary objects of interest are:
+
+`lsst.cbp.CoordinateConverter`: compute the telescope and CBP pointing that will give you a desired beam arrangement, such as placing beam *b* at point *p* on the pupil and point *d* on a specified detector.
+
+`lsst.cbp.computeHolePositions`: compute hole positions for a CBP mask.
+
+To construct an `lsst.cbp.CoordinateConverter` you will need to learn about configuration:
+
+.. toctree::
+
+    configuration
+
+In order to :ref:`configure <lsst.cbp.configuration>` and use an `lsst.cbp.CoordinateConverter` it may help to have some understanding of the coordinate systems involved:
+
+.. toctree::
+
+    coordinateFrames
+
+Python API reference
+====================
+
+.. automodapi:: lsst.cbp
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.cbp.coordUtils
+   :no-main-docstr:
+   :no-inheritance-diagram:
+
+.. automodapi:: lsst.cbp.testUtils
+   :no-main-docstr:
+   :no-inheritance-diagram:
diff --git a/doc/pupil_frame_daz_dalt.png → doc/lsst.cbp/pupil_frame_daz_dalt.png b/doc/pupil_frame_daz_dalt.png → doc/lsst.cbp/pupil_frame_daz_dalt.png
diff --git a/doc/pupil_frame_daz_dalt.vc6 → doc/lsst.cbp/pupil_frame_daz_dalt.vc6 b/doc/pupil_frame_daz_dalt.vc6 → doc/lsst.cbp/pupil_frame_daz_dalt.vc6
diff --git a/doc/pupil_plane_flipped_x.png → doc/lsst.cbp/pupil_plane_flipped_x.png b/doc/pupil_plane_flipped_x.png → doc/lsst.cbp/pupil_plane_flipped_x.png
diff --git a/doc/pupil_plane_flipped_x.vc6 → doc/lsst.cbp/pupil_plane_flipped_x.vc6 b/doc/pupil_plane_flipped_x.vc6 → doc/lsst.cbp/pupil_plane_flipped_x.vc6