DM-11639: Initial Sphinx documentation for pipelines.lsst.io #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SimonKrughoff
approved these changes
Aug 26, 2017
| ``verify_metrics`` provides centralized metric and specification definitions for the LSST Science Pipelines Verification Framework. | ||
| The :ref:`lsst.verify <lsst.verify>` module uses these metrics and specifications by default. | ||
|
|
||
| For background, see the SQR-017_ (design) and SQR-019_ (demo) technotes. |
There was a problem hiding this comment.
Oh nm. I see these are footnotes.
| @@ -7,6 +7,6 @@ This directory contains *metric definition* YAML files for each EUPS package tha | |||
| Files are named after the EUPS package. | |||
| For example: ``validate_drp.yaml`` for the `validate_drp`_ package. | |||
|
|
|||
| The format of these YAML files is *currently* documented in https://sqr-017.lsst.io/v/DM-9533/index.html#metric-yaml. | |||
| The format of these YAML files is *currently* documented in https://sqr-017.lsst.io/index.html#metric-yaml. | |||
There was a problem hiding this comment.
Are these files to end up in pipelines_lsst_io, and if so, how are they discovered?
There was a problem hiding this comment.
@SimonKrughoff, good point. Schema references and user guides for creating new metric and specification YAML definitions will end up in the lsst.verify user guide in pipelines.lsst.io. It'll go there since the format is defined in lsst.verify and verify_metrics just happens to be the default package for declaring metrics and specifications.
We'll deprecate both SQR-017 and SQR-019, which have mostly helped us communicate early development.
- doc/index.rst is now only used for local documentation previews. It links to documentation directories. - doc/verify_metrics/index.rst is an example of **package** documentation (i.e., for an EUPS package/Git repo). As a proof-of-concept I'm using content from README.rst; the format of this type of documentation might change. - doc/manifest.yaml declares documentation content in the doc/ directory. The manifest.yaml schema is currently documented in documenteer. Note that only the package documentation is declared; there are no python modules to document.
These were for prototyping and aren't needed anymore with integrated pipelines.lsst.io sphinx builds.
This is a small maintenance update-- Really we need to have official schema docs in the lsst.verify module documentation (metric/spec YAML files can come from many different packages).
jonathansick
force-pushed
the
tickets/DM-11639
branch
from
9c9b8e6
to
929f0ba
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds boilerplate to
verify_metricsfor integration with pipelines.lsst.io.Draft of the package documentation: https://pipelines.lsst.io/v/DM-11639/packages/verify_metrics/