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-17827: Update doc directory to match templates #101

Merged
merged 1 commit into from
Feb 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
63 changes: 0 additions & 63 deletions doc/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion doc/_templates/autosummary/base.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/_templates/autosummary/class.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/_templates/autosummary/module.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 @@ validate_drp documentation preview
.. toctree::
:maxdepth: 1

validate_drp/index
lsst.validate.drp/index
21 changes: 18 additions & 3 deletions doc/lsst.validate.drp/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
.. py:currentmodule:: lsst.validate.drp

.. _lsst.validate.drp:

#################
lsst.validate.drp
#################

.. Paragraph that describes what this Python module does and links to related modules and frameworks.
The ``lsst.validate.drp`` module provides utilities for measuring and plotting Key Performance Metrics (KPMs) on processed LSST data.

.. _lsst.validate.drp-contributing:

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

.. Add subsections with toctree to individual topic pages.
``lsst.validate.drp`` is developed at https://github.com/lsst/validate_drp.
You can find Jira issues for this module under the `validate_drp <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20validate_drp>`_ component.

.. _lsst.validate.drp-pyapi:

Python API reference
====================

.. automodapi:: lsst.validate.drp
:no-main-docstr:
.. automodapi:: lsst.validate.drp.validate
:no-main-docstr:
.. automodapi:: lsst.validate.drp.util
:no-main-docstr:
.. automodapi:: lsst.validate.drp.matchedVisitMetricsTask
:no-main-docstr:
.. automodapi:: lsst.validate.drp.photerrmodel
:no-main-docstr:
.. automodapi:: lsst.validate.drp.astromerrmodel

:no-main-docstr:
9 changes: 0 additions & 9 deletions doc/manifest.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
# Documentation manifest.

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

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

# Name of the static content directories (subdirectories of `_static`).
# Static content directories are usually named after the package.
statics:
- "_static/validate_drp"
5 changes: 0 additions & 5 deletions doc/requirements.txt

This file was deleted.

27 changes: 0 additions & 27 deletions doc/validate_drp/index.rst

This file was deleted.