Skip to content

Commit

Permalink
Clarify docs headers (#446)
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram authored Sep 26, 2024
2 parents bdd9a9b + 87da3f2 commit b9df6e9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 11 deletions.
1 change: 1 addition & 0 deletions changes/446.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update schema docs to clarify headings and add links to roman_datamodels and asdf.
4 changes: 2 additions & 2 deletions docs/ground_tests.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ground_tests:

Ground Tests File Schemas
=========================
Ground Tests Schemas
====================

FPS
---
Expand Down
2 changes: 1 addition & 1 deletion docs/reference_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Reference File Schemas
======================

Nancy Grace Roman Space Telescope Reference Files:
Schemas used in Nancy Grace Roman Space Telescope Reference Files:

.. asdf-autoschemas::
:standard_prefix: schemas/reference_files
Expand Down
20 changes: 12 additions & 8 deletions docs/schemas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,33 @@
Science Products Schemas
========================

Level 1 (uncalibrated) File schema
----------------------------------
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:`asdf-standard:asdf-schemas` for more information about ASDF schemas.

Level 1 (uncalibrated) schema
-----------------------------

.. asdf-autoschemas::

wfi_science_raw-1.0.0

Level 2 (calibrated exposure) File schema
-----------------------------------------
Level 2 (calibrated exposure) schema
------------------------------------

.. asdf-autoschemas::

wfi_image-1.0.0

Level 3 (resampled mosaic) File schema
--------------------------------------
Level 3 (resampled mosaic) schema
---------------------------------

.. asdf-autoschemas::

wfi_mosaic-1.0.0

Level 4 File schemas
--------------------
Level 4 (ancillary) schemas
---------------------------

.. asdf-autoschemas::

Expand Down

0 comments on commit b9df6e9

Please sign in to comment.