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.

Sign up for GitHub

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

RAD-160: FY24 Document Review #514

Merged
merged 8 commits into from
Dec 3, 2024
Merged

RAD-160: FY24 Document Review #514

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
709cb2d
Initial Commit
PaulHuwe Nov 21, 2024
62a4335
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 21, 2024
3715cfb
Added change log.
PaulHuwe Nov 21, 2024
cc69de8
Merge branch 'RAD-160_FY24Docs' of https://github.com/PaulHuwe/rad in…
PaulHuwe Nov 21, 2024
4daf96b
Moved change log.
PaulHuwe Nov 21, 2024
a27d815
Merge branch 'main' of https://github.com/spacetelescope/rad into RAD…
PaulHuwe Dec 2, 2024
0631874
Rolled back asdf version dependency.
PaulHuwe Dec 2, 2024
68b7213
Update docs/conf.py
PaulHuwe Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/514.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updates the RAD documentation to match the current schemas and fixes broken links.
43 changes: 43 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-standard.readthedocs.io/en/latest/generated/stsci.edu/asdf/wcs/wcs-1.0.0.html"),
PaulHuwe marked this conversation as resolved.
Show resolved Hide resolved
]
2 changes: 0 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,3 @@ Index
=====

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
9 changes: 8 additions & 1 deletion docs/schemas.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Loading