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

Commits on Jul 12, 2018

  1. Improve wcsUtils docstring syntax

    - Fix the literals formatting in computePixelToDistortedPixel.
    - Add cross references and other minor syntax improvements.
    jonathansick committed Jul 12, 2018
    Configuration menu
    Copy the full SHA
    d478cad View commit details
    Browse the repository at this point in the history
  2. Expand skipped lsst.afw.geom api objects

    These objects were generating doctree not found errors (See DM-15056). I
    think this is because some code was filtering out lsst.geom APIs, but
    not fully. Manually filtering them in the automodapi directive solves
    the problem for now.
    jonathansick committed Jul 12, 2018
    Configuration menu
    Copy the full SHA
    a46d13a View commit details
    Browse the repository at this point in the history
  3. Add no-main-docstr option to automodapi

    This is what we want, design-wise.
    jonathansick committed Jul 12, 2018
    Configuration menu
    Copy the full SHA
    1d3fd8b View commit details
    Browse the repository at this point in the history
  4. Move FITS headers page into lsst.afw.image docs

    This adds the FITS header reference page into the right directory. This
    also sets up the standardized structure of the lsst.afw.image module
    homepage.
    jonathansick committed Jul 12, 2018
    Configuration menu
    Copy the full SHA
    a211d76 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2018

  1. Format FITS keywords in list-table

    This will be easier to maintain than the drawn tables.
    jonathansick committed Jul 13, 2018
    Configuration menu
    Copy the full SHA
    76baf30 View commit details
    Browse the repository at this point in the history
  2. Merge accessor and description columns

    This makes the table a bit easier to read since it allows the
    description column to be wider. The accessor is still quite apparent
    thanks to its formatting, and role as a link to the API reference.
    jonathansick committed Jul 13, 2018
    Configuration menu
    Copy the full SHA
    a3a3cfd View commit details
    Browse the repository at this point in the history
  3. Update LTV[12] keyword docs for WCS A

    LTV1 and LTV2 no longer hold XY0 (those keywords are still written,
    though we probably should not mention that, as LSST code never reads
    them). XY0 is now encoded as WCS "A" using the following keywords:
    
    CRPIX[12]A = 1
    CRVAL[12]A = xy0
    CTYPE[12]A = "LINEAR"
    CUNIT[12]A = "PIXEL"
    
    where [12] means 1 or 2, so CRPIX1 = CRPIX2 = 1, CRVAL1A = xy0[0],
    CRVAL2A = xy0[1], etc.
    jonathansick committed Jul 13, 2018
    Configuration menu
    Copy the full SHA
    a2ee70d View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    dd95226 View commit details
    Browse the repository at this point in the history
  5. Move Footprint topic into lsst.afw.detection docs

    This moves the Footprint.rst topic into the right place, and deletes the
    older doc/detection directory.
    jonathansick committed Jul 13, 2018
    Configuration menu
    Copy the full SHA
    ac68eee View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    8fea986 View commit details
    Browse the repository at this point in the history
  7. Delete old Sphinx infrastructure

    No longer needed with stack-docs and package-docs command line tools.
    jonathansick committed Jul 13, 2018
    Configuration menu
    Copy the full SHA
    218e8fb View commit details
    Browse the repository at this point in the history