Skip to content

Commit

Permalink
Update doc/ to follow template
Browse files Browse the repository at this point in the history
- Drop unneeded package doc directory
- Update the module homepage with new boilerplate
  • Loading branch information
jonathansick committed Feb 9, 2019
1 parent 4dada71 commit ce6b066
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 40 deletions.
27 changes: 0 additions & 27 deletions doc/coadd_utils/index.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ coadd_utils documentation preview
.. toctree::
:maxdepth: 1

coadd_utils/index
lsst.coadd.utils/index
14 changes: 12 additions & 2 deletions doc/lsst.coadd.utils/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
.. py:currentmodule:: lsst.coadd.utils
.. _lsst.coadd.utils:

################
lsst.coadd.utils
################

.. Paragraph that describes what this Python module does and links to related modules and frameworks.
The ``lsst.coadd.utils`` module provides base classes for coadding images produced with the LSST Science Pipelines.

.. _lsst.coadd.utils-contributing:

Contributing
============

``lsst.coadd.utils`` is developed at https://github.com/lsst/coadd_utils.
You can find Jira issues for this module under the `coadd_utils <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20coadd_utils>`_ component.

.. Add subsections with toctree to individual topic pages.
.. _lsst.coadd.utils-pyapi:

Python API reference
====================
Expand Down
10 changes: 0 additions & 10 deletions doc/manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
# Documentation manifest.

# Name of this package
# Also the name of the package documentation subdirectory.
package: "coadd_utils"

# List of names of Python modules in this package.
# For each module there is a corresponding module doc subdirectory.
modules:
- "lsst.coadd.utils"

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
statics:
- "_static/coadd_utils"

0 comments on commit ce6b066

Please sign in to comment.