Skip to content

Commit 81d8ea4

Browse files
committed
Fix docs build
1 parent 48abe44 commit 81d8ea4

4 files changed

Lines changed: 9 additions & 6 deletions

File tree

astroquery/mast/missions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -993,7 +993,7 @@ def read_product(self, uri, *, mission=None, **kwargs):
993993
Supported file types are FITS and ASDF.
994994
995995
FITS files are opened with `~astropy.io.fits.open` and are downloaded and cached on disk. ASDF files
996-
are opened directly from the presigned S3 URL using `fsspec` and `asdf`, without being downloaded to disk.
996+
are opened directly from the presigned S3 URL using `~fsspec.open` and `~asdf.open`, without being downloaded to disk.
997997
998998
Parameters
999999
----------

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@
5656
'regions': ('https://astropy-regions.readthedocs.io/en/stable', None),
5757
'mocpy': ('https://cds-astro.github.io/mocpy', None),
5858
'pyvo': ('https://pyvo.readthedocs.io/en/stable', None),
59-
'asdf': ('https://asdf.readthedocs.io/en/stable/', None),
59+
'asdf': ('https://asdf.readthedocs.io/en/stable', None),
60+
'fsspec': ('https://filesystem-spec.readthedocs.io/en/stable', None),
6061
})
6162

6263
# -- Project information ------------------------------------------------------

docs/mast/mast_missions.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -335,10 +335,11 @@ or `~asdf.AsdfFile` objects, respectively. The function accepts a product URI or
335335

336336
FITS files are opened with `~astropy.io.fits.open` and are downloaded and cached locally.
337337

338-
ASDF products from the Roman Space Telescope mission are opened directly as `~asdf.AsdfFile` objects from presigned S3 URLs,
339-
without being downloaded locally. This requires the `~asdf` and `~fsspec` packages to be installed. Other optional packages for
340-
reading products may be required depending on the product type and file format. These packages are ``gwcs``, ``lz4``, and ``roman_datamodels``.
341-
To install astroquery with all optional dependencies, use ``pip install astroquery[all]``.
338+
ASDF products from the Roman Space Telescope mission are opened directly with `~fsspec.open` and `~asdf.open`. The products are
339+
read as `~asdf.AsdfFile` objects from presigned S3 URLs, without being downloaded locally. This requires the ``asdf`` and ``fsspec``
340+
packages to be installed. Other optional packages for reading products may be required depending on the product type and file format.
341+
These packages are ``gwcs``, ``lz4``, and ``roman_datamodels``. To install astroquery with all optional dependencies,
342+
use ``pip install astroquery[all]``.
342343

343344
Remember that this method returns an open file object, so it is the user's responsibility to close the file when finished. This can be done
344345
with a context manager or by calling the ``close()`` method on the returned object.

tox.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ deps =
5454
oldestdeps-alldeps: regions==0.5
5555
oldestdeps-alldeps: astropy-healpix==0.7
5656
oldestdeps-alldeps: gwcs==0.18
57+
oldestdeps-alldeps: roman_datamodels==0.11.0
5758

5859
online: pytest-custom_exit_code
5960

0 commit comments

Comments
 (0)