Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-15056: Fix lsst.afw.geom documentation build issue and misc doc improvements #371

Merged
merged 11 commits into from
Jul 13, 2018
77 changes: 0 additions & 77 deletions doc/FITS headers for exposures.rst

This file was deleted.

64 changes: 0 additions & 64 deletions doc/Makefile

This file was deleted.

6 changes: 0 additions & 6 deletions doc/detection/index.rst

This file was deleted.

2 changes: 0 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,3 @@ afw documentation preview
lsst.afw.image/index
lsst.afw.math/index
lsst.afw.table/index
detection/index
FITS headers for exposures.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#########
Footprint
#########
###############################################################
Using lsst.afw.detection.Footprint to represent detection areas
###############################################################

The fundamental unit of a detection in the LSST pipeline is an instance of the
``Footprint`` class. This class contains the x, y locations for pixels that are
Expand Down
10 changes: 9 additions & 1 deletion doc/lsst.afw.detection/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ lsst.afw.detection

.. Paragraph that describes what this Python module does and links to related modules and frameworks.

.. Add subsections with toctree to individual topic pages.
.. _lsst.afw.detection-using:

Using lsst.afw.detection
========================

.. toctree::
:maxdepth: 1

Footprint

Python API reference
====================
Expand Down
6 changes: 3 additions & 3 deletions doc/lsst.afw.geom/SpanSet.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#######
SpanSet
#######
####################################################################
Using lsst.afw.geom.SpanSet to represent irregular regions of pixels
####################################################################

A ``SpanSet`` is a class that represents regions of pixels on an image. As the
name implies, a ``SpanSet`` is a collection of ``Span`` objects which behave as
Expand Down
5 changes: 4 additions & 1 deletion doc/lsst.afw.geom/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,8 @@ Python API reference
====================

.. automodapi:: lsst.afw.geom
:skip: SinglePolygonException
:no-main-docstr:
:skip: SinglePolygonException, all, any, arcsecToRad, averageSpherePoint, ceil, degToRad, floor, isAngle, makeAffineTransformFromTriple, masToRad, radToArcsec, radToDeg, radToMas, truncate, AffineTransform, Angle, AngleUnit, Box2I, BoxD, BoxI, Box2D, CoordinateBaseCoordinateExpr2, CoordinateBaseCoordinateExpr3, CoordinateBaseExtent2D, CoordinateBaseExtent2I, CoordinateBaseExtent3D, CoordinateBaseExtent3I, CoordinateBasePoint2D, CoordinateBasePoint2I, CoordinateBasePoint3D, CoordinateBasePoint3I, CoordinateExpr, CoordinateExpr2, CoordinateExpr3, Extent, Extent2D, Extent2I, Extent3D, Extent3I, ExtentBase2D, ExtentBase2I, ExtentBase3D, ExtentBase3I, ExtentD, ExtentI, LinearTransform, Point, Point2D, Point2I, Point3D, Point3I, PointBase2D, PointBase2I, PointBase3D, PointBase3I, PointD, PointI, SpherePoint

.. automodapi:: lsst.afw.geom.testUtils
:no-main-docstr: