Merge pull request #2262 from eerovaher/doc-build-fix

Fix documentation build

Author: bsipocz

astroquery/alma/core.py

@@ -20,6 +20,7 @@
 from astropy.utils.exceptions import AstropyDeprecationWarning
 from astropy import units as u
 from astropy.time import Time
+from pyvo.dal.sia2 import SIA_PARAMETERS_DESC
 
 from ..exceptions import LoginError
 from ..utils import commons
@@ -397,6 +398,7 @@ def query_sia(self, pos=None, band=None, time=None, pol=None,
 
         Parameters
         ----------
+        _SIA2_PARAMETERS
 
         Returns
         -------
@@ -424,6 +426,12 @@ def query_sia(self, pos=None, band=None, time=None, pol=None,
             maxrec=maxrec,
             **kwargs)
 
+    # SIA_PARAMETERS_DESC contains links that Sphinx can't resolve.
+    for var in ('POLARIZATION_STATES', 'CALIBRATION_LEVELS'):
+        SIA_PARAMETERS_DESC = SIA_PARAMETERS_DESC.replace(f'`pyvo.dam.obscore.{var}`',
+                                                          f'pyvo.dam.obscore.{var}')
+    query_sia.__doc__ = query_sia.__doc__.replace('_SIA2_PARAMETERS', SIA_PARAMETERS_DESC)
+
     def query_tap(self, query, maxrec=None):
         """
         Send query to the ALMA TAP. Results in pyvo.dal.TapResult format.

astroquery/ipac/irsa/irsa_dust/core.py

@@ -123,7 +123,7 @@ def get_images_async(self, coordinate, radius=None, image_type=None,
             to remote server. Defaults to `False`.
 
         Returns
-        --------
+        -------
         list : list
             A list of context-managers that yield readable file-like objects.
         """
@@ -146,7 +146,7 @@ def get_image_list(self, coordinate, radius=None, image_type=None,
         of URLs to the Irsa-Dust images.
 
         Parameters
-        -----------
+        ----------
         coordinate : str
             Can be either the name of an object or a coordinate string
             If a name, must be resolvable by NED, SIMBAD, 2MASS, or SWAS.
@@ -169,7 +169,7 @@ def get_image_list(self, coordinate, radius=None, image_type=None,
             to remote server. Defaults to `False`.
 
         Returns
-        --------
+        -------
         url_list : list
             A list of URLs to the FITS images corresponding to the queried
             object.
@@ -203,7 +203,7 @@ def get_extinction_table(self, coordinate, radius=None, timeout=TIMEOUT,
             server. Defaults to `~astroquery.ipac.irsa.irsa_dust.IrsaDustClass.TIMEOUT`.
 
         Returns
-        --------
+        -------
         table : `~astropy.table.Table`
         """
         readable_obj = self.get_extinction_table_async(
@@ -289,7 +289,7 @@ def get_query_table(self, coordinate, radius=None,
             Defaults to `~astroquery.ipac.irsa.irsa_dust.IrsaDustClass.DUST_SERVICE_URL`.
 
         Returns
-        --------
+        -------
         table : `~astropy.table.Table`
             Table representing the query results, (all or as per  specified).
         """

astroquery/ipac/ned/core.py

@@ -385,7 +385,7 @@ def get_images_async(self, object_name, get_query_payload=False,
             request.  Defaults to `False`
 
         Returns
-        --------
+        -------
         A list of context-managers that yield readable file-like objects
 
         """
@@ -438,7 +438,7 @@ def get_spectra_async(self, object_name, get_query_payload=False,
             request.  Defaults to `False`
 
         Returns
-        --------
+        -------
         A list of context-managers that yield readable file-like objects
 
         """

astroquery/jplspec/core.py

@@ -191,12 +191,12 @@ def get_species_table(self, catfile='catdir.cat'):
         | (I6,X, A13, I6, 7F7.4,  I2)
 
         Parameters
-        -----------
+        ----------
         catfile : str, name of file, default 'catdir.cat'
             The catalog file, installed locally along with the package
 
         Returns
-        --------
+        -------
         Table: `~astropy.table.Table`
             | TAG : The species tag or molecular identifier.
             | NAME : An ASCII name for the species.

astroquery/linelists/cdms/core.py

@@ -254,12 +254,12 @@ def get_species_table(self, catfile='catdir.cat'):
         The table is derived from https://cdms.astro.uni-koeln.de/classic/entries/partition_function.html
 
         Parameters
-        -----------
+        ----------
         catfile : str, name of file, default 'catdir.cat'
             The catalog file, installed locally along with the package
 
         Returns
-        --------
+        -------
         Table: `~astropy.table.Table`
             | tag : The species tag or molecular identifier.
             | molecule : An ASCII name for the species.

astroquery/mast/collections.py

@@ -320,7 +320,7 @@ def query_hsc_matchid_async(self, match, version=3, pagesize=None, page=None):
             one sepcific page of results.
 
         Returns
-        --------
+        -------
         response : list of `~requests.Response`
         """
 
@@ -356,7 +356,7 @@ def get_hsc_spectra_async(self, pagesize=None, page=None):
             one sepcific page of results.
 
         Returns
-        --------
+        -------
         response : list of `~requests.Response`
         """
 
@@ -387,7 +387,7 @@ def download_hsc_spectra(self, spectra, download_dir=None, cache=True, curl_flag
             will be downloaded that can be used to download the data files at a later time.
 
         Returns
-        --------
+        -------
         response : list of `~requests.Response`
         """
 

astroquery/mast/observations.py

@@ -76,7 +76,7 @@ def list_missions(self):
         Lists data missions archived by MAST and avaiable through `astroquery.mast`.
 
         Returns
-        --------
+        -------
         response : list
             List of available missions.
         """
@@ -106,7 +106,7 @@ def get_metadata(self, query_type):
             The query to get metadata for. Options are observations, and products.
 
         Returns
-        --------
+        -------
         response : `~astropy.table.Table`
             The metadata table.
         """

astroquery/open_exoplanet_catalogue/oec_query.py

@@ -19,7 +19,7 @@ def get_catalogue(filepath=None):
     Parses the Open Exoplanet Catalogue file.
 
     Parameters
-    -----------
+    ----------
     filepath : str or None
         if no filepath is given, remote source is used.
 

astroquery/vo_conesearch/validator/inspect.py

@@ -138,7 +138,7 @@ def print_cat(self, key, fout=None):
         If not found, nothing is written out.
 
         Parameters
-        -----------
+        ----------
         key : str
             Catalog key.