From 09df40af5ea59acb6f76ea515c11d425fa90d990 Mon Sep 17 00:00:00 2001 From: Brett Date: Wed, 6 Nov 2024 14:15:19 -0500 Subject: [PATCH] add schema to docs --- .../schemas/nddata/stddevuncertainty-1.0.0.yaml | 5 ++--- .../schemas/nddata/unknownuncertainty-1.0.0.yaml | 5 ++--- .../schemas/nddata/varianceuncertainty-1.0.0.yaml | 5 ++--- docs/asdf-astropy/schemas.rst | 15 +++++++++++++++ 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/asdf_astropy/resources/schemas/nddata/stddevuncertainty-1.0.0.yaml b/asdf_astropy/resources/schemas/nddata/stddevuncertainty-1.0.0.yaml index bf288538..514cf61f 100644 --- a/asdf_astropy/resources/schemas/nddata/stddevuncertainty-1.0.0.yaml +++ b/asdf_astropy/resources/schemas/nddata/stddevuncertainty-1.0.0.yaml @@ -3,10 +3,9 @@ $schema: "http://stsci.edu/schemas/yaml-schema/draft-01" id: "http://astropy.org/schemas/astropy/nddata/stddevuncertainty-1.0.0" -title: - Represents the astropy.nddata.StdDevUncertainty class +title: Represents the astropy.nddata.StdDevUncertainty class -description: +description: >- This object represents the `StdDevUncertainty` class, which is a subclass of the `NDUncertainty` class from `astropy.nddata` diff --git a/asdf_astropy/resources/schemas/nddata/unknownuncertainty-1.0.0.yaml b/asdf_astropy/resources/schemas/nddata/unknownuncertainty-1.0.0.yaml index ee8b9983..b384ff66 100644 --- a/asdf_astropy/resources/schemas/nddata/unknownuncertainty-1.0.0.yaml +++ b/asdf_astropy/resources/schemas/nddata/unknownuncertainty-1.0.0.yaml @@ -3,10 +3,9 @@ $schema: "http://stsci.edu/schemas/yaml-schema/draft-01" id: "http://astropy.org/schemas/astropy/nddata/unknownuncertainty-1.0.0" -title: - Represents the astropy.nddata.UnknownUncertainty class +title: Represents the astropy.nddata.UnknownUncertainty class -description: +description: >- This object represents the `UnknownUncertainty` class, which is a subclass of the `NDUncertainty` class from `astropy.nddata` diff --git a/asdf_astropy/resources/schemas/nddata/varianceuncertainty-1.0.0.yaml b/asdf_astropy/resources/schemas/nddata/varianceuncertainty-1.0.0.yaml index d1a36df5..7ccb46d4 100644 --- a/asdf_astropy/resources/schemas/nddata/varianceuncertainty-1.0.0.yaml +++ b/asdf_astropy/resources/schemas/nddata/varianceuncertainty-1.0.0.yaml @@ -3,10 +3,9 @@ $schema: "http://stsci.edu/schemas/yaml-schema/draft-01" id: "http://astropy.org/schemas/astropy/nddata/varianceuncertainty-1.0.0" -title: - Represents the astropy.nddata.VarianceUncertainty class +title: Represents the astropy.nddata.VarianceUncertainty class -description: +description: >- This object represents the `VarianceUncertainty` class, which is a subclass of the `NDUncertainty` class from `astropy.nddata` diff --git a/docs/asdf-astropy/schemas.rst b/docs/asdf-astropy/schemas.rst index 5c60b849..ba6be745 100644 --- a/docs/asdf-astropy/schemas.rst +++ b/docs/asdf-astropy/schemas.rst @@ -30,6 +30,21 @@ fits/fits-1.0.0 fits/fits-1.0.0 +NDData +------ + +The following schemas are associated with **astropy** objects from the +:ref:`astropy_nddata` submodule: + +units/equivalency-1.0.0 +^^^^^^^^^^^^^^^^^^^^^^^ + +.. asdf-autoschemas:: + + nddata/stddevuncertainty-1.0.0 + nddata/unknownuncertainty-1.0.0 + nddata/varianceuncertainty-1.0.0 + Table -----