RAD-160: FY24 Document Review (#514)

* Initial Commit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added change log.

* Moved change log.

* Rolled back asdf version dependency.

* Update docs/conf.py

Co-authored-by: Brett Graham <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Brett Graham <[email protected]>

changes/514.doc.rst

@@ -0,0 +1 @@
+Updates the RAD documentation to match the current schemas and fixes broken links.

docs/conf.py

@@ -155,5 +155,48 @@ def setup(app):
 # This is the prefix common to all schema IDs in this repository
 asdf_schema_standard_prefix = "schemas"
 asdf_schema_reference_mappings = [
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/calibration_software_name-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/calibration_software_name-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/calibration_software_version-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/calibration_software_version-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/filename-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/filename-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/file_date-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/file_date-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/model_type-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/model_type-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/origin-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/origin-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/prd_version-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/prd_version-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/product_type-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/product_type-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/sdf_software_version-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/sdf_software_version-1.0.0.html",
+    ),
+    (
+        "asdf://stsci.edu/datamodels/roman/tags/telescope-1.0.0",
+        "https://rad.readthedocs.io/en/latest/generated/schemas/tagged_scalars/telescope-1.0.0.html",
+    ),
     ("asdf://stsci.edu/datamodels/roman/tags/", "https://rad.readthedocs.io/en/latest/generated/schemas/"),
+    ("asdf://stsci.edu/datamodels/roman/schemas/", "https://rad.readthedocs.io/en/latest/generated/schemas/"),
+    ("http://stsci.edu/schemas/asdf/", "https://asdf-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/"),
+    ("tag:stsci.edu:gwcs/wcs-*", "https://asdf-wcs-schemas.readthedocs.io/en/latest/generated/gwcs/wcs-1.0.0.html"),
 ]

docs/index.rst

@@ -42,5 +42,3 @@ Index
 =====
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/schemas.rst

@@ -4,7 +4,7 @@ Science Products Schemas
 ========================
 
 The following ASDF schemas define the structures used in Nancy Grace Roman Space Telescope files.
-See :ref:doc:`roman_datamodels:roman_datamodels/datamodels/general_structure` for more details about how these schemeas are used.
+See :ref:doc:`roman_datamodels:roman_datamodels/datamodels/general_structure` for more details about how these schemas are used.
 See :ref:`asdf-standard:asdf-schemas` for more information about ASDF schemas.
 
 Level 1 (uncalibrated) schema
@@ -63,14 +63,18 @@ Tags
     mosaic_wcsinfo-1.0.0
     msos_stack-1.0.0
     observation-1.0.0
+    outlier_detection-1.0.0
     photometry-1.0.0
     pointing-1.0.0
     program-1.0.0
     rad_schema-1.0.0
     ramp_fit_output-1.0.0
     ramp-1.0.0
+    rcs-1.0.0
     ref_file-1.0.0
     resample-1.0.0
+    sky_background-1.0.0
+    statistics-1.0.0
     source_detection-1.0.0
     velocity_aberration-1.0.0
     visit-1.0.0
@@ -79,9 +83,12 @@ Tags
     wfi_mode-1.0.0
     wfi_optical_element-1.0.0
     tagged_scalars/file_date-1.0.0
+    tagged_scalars/calibration_software_name-1.0.0
     tagged_scalars/calibration_software_version-1.0.0
     tagged_scalars/filename-1.0.0
     tagged_scalars/model_type-1.0.0
     tagged_scalars/origin-1.0.0
+    tagged_scalars/prd_version-1.0.0
+    tagged_scalars/product_type-1.0.0
     tagged_scalars/sdf_software_version-1.0.0
     tagged_scalars/telescope-1.0.0