use canonical filename of RTD configuration and enable nitpicky mode

.github/labeler.yml

@@ -1,6 +1,6 @@
 docs:
   - .github/**/*.md
-  - .readthedocs.yml
+  - .readthedocs.yaml
   - docs/*
   - docs/_static/*
   - docs/_templates/*

docs/conf.py

@@ -138,3 +138,9 @@
 linkcheck_ignore = ['https://hsthelp.stsci.edu']
 linkcheck_timeout = 180
 linkcheck_anchors = False
+
+# Enable nitpicky mode - which ensures that all references in the docs resolve.
+nitpicky = True
+nitpick_ignore = [
+    ('py:class', 'synphot.models.BaseGaussian1D'),
+]

synphot/observation.py

@@ -254,7 +254,7 @@ def sample_binned(self, wavelengths=None, flux_unit=None, **kwargs):
             If not a Quantity, assumed to be in Angstrom.
             If `None`, `binset` is used.
 
-        flux_unit : str or `~astropy.units.core.Unit` or `None`
+        flux_unit : str or `~astropy.units.Unit` or `None`
             Flux is converted to this unit.
             If not given, internal unit is used.
 
@@ -426,7 +426,7 @@ def effstim(self, flux_unit=None, wavelengths=None, area=None,
 
         Parameters
         ----------
-        flux_unit : str or `~astropy.units.core.Unit` or `None`
+        flux_unit : str or `~astropy.units.Unit` or `None`
             The unit of effective stimulus.
             COUNT gives result in count/s (see :meth:`countrate` for more
             options).
@@ -638,7 +638,7 @@ def plot(self, binned=True, wavelengths=None, flux_unit=None, area=None,
             If `None`, ``self.waveset`` or `binset` is used, depending
             on ``binned``.
 
-        flux_unit : str or `~astropy.units.core.Unit` or `None`
+        flux_unit : str or `~astropy.units.Unit` or `None`
             Flux is converted to this unit for plotting.
             If not given, internal unit is used.
 

synphot/specio.py

@@ -113,12 +113,12 @@ def read_ascii_spec(filename, wave_unit=u.AA, flux_unit=units.FLAM, **kwargs):
     filename : str or file pointer
         Spectrum file name or pointer.
 
-    wave_unit, flux_unit : str or `~astropy.units.core.Unit`
+    wave_unit, flux_unit : str or `~astropy.units.Unit`
         Wavelength and flux units, which default to Angstrom and FLAM,
         respectively.
 
     kwargs : dict
-        Keywords accepted by :func:`astropy.io.ascii.ui.read`.
+        Keywords accepted by :func:`astropy.io.ascii.read`.
 
     Returns
     -------
@@ -164,7 +164,7 @@ def read_fits_spec(filename, ext=1, wave_col='WAVELENGTH', flux_col='FLUX',
     wave_col, flux_col : str
         Wavelength and flux column names (case-insensitive).
 
-    wave_unit, flux_unit : str or `~astropy.units.core.Unit`
+    wave_unit, flux_unit : str or `~astropy.units.Unit`
         Wavelength and flux units, which default to Angstrom and FLAM,
         respectively. These are *only* used if ``TUNIT1`` and ``TUNIT2``
         keywords are not present in table (not primary) header.
@@ -264,7 +264,7 @@ def write_fits_spec(filename, wavelengths, fluxes, pri_header={},
     wave_col, flux_col : str
         Wavelength and flux column names (case-insensitive).
 
-    wave_unit, flux_unit : str or `~astropy.units.core.Unit`
+    wave_unit, flux_unit : str or `~astropy.units.Unit`
         Wavelength and flux units, which default to Angstrom and FLAM,
         respectively. These are *only* used if wavelengths and fluxes
         are not in astropy quantities.

synphot/spectrum.py

@@ -45,7 +45,7 @@ class BaseSpectrum:
     Parameters
     ----------
     modelclass : cls
-        Model class from `astropy.modeling.models`.
+        Model class from `astropy.modeling`.
 
     clean_meta : bool
         Scrub "expr" and "header" entries from input metadata before merging.
@@ -447,7 +447,7 @@ def integrate(self, wavelengths=None, integration_type=None, **kwargs):
             integration is requested but no possible, trapezoid integration
             is done anyway.
 
-        flux_unit : str, `~astropy.units.core.Unit`, or `None`
+        flux_unit : str, `~astropy.units.Unit`, or `None`
             **This option is only available for source spectrum.**
             For trapezoid integration, flux is converted to this unit for
             sampling before integration. For analytical integration, while
@@ -863,7 +863,7 @@ def to_spectrum1d(self, wavelengths=None, **kwargs):
             If not a Quantity, assumed to be in Angstrom.
             If `None`, ``self.waveset`` is used.
 
-        flux_unit : str, `~astropy.units.core.Unit`, or `None`
+        flux_unit : str, `~astropy.units.Unit`, or `None`
             This option is not applicable to unitless spectrum like bandpass.
             Flux is converted to this unit before written out.
             If not given, internal unit is used.
@@ -928,7 +928,7 @@ def __call__(self, wavelengths, flux_unit=None, **kwargs):
             Wavelength values for sampling. If not a Quantity,
             assumed to be in Angstrom.
 
-        flux_unit : str, `~astropy.units.core.Unit`, or `None`
+        flux_unit : str, `~astropy.units.Unit`, or `None`
             Flux is converted to this unit.
             If not given, internal unit is used.
 
@@ -1271,7 +1271,7 @@ def plot(self, wavelengths=None, flux_unit=None, area=None, vegaspec=None,
             If not a Quantity, assumed to be in Angstrom.
             If `None`, ``self.waveset`` is used.
 
-        flux_unit : str, `~astropy.units.core.Unit`, or `None`
+        flux_unit : str, `~astropy.units.Unit`, or `None`
             Flux is converted to this unit for plotting.
             If not given, internal unit is used.
 
@@ -1305,7 +1305,7 @@ def to_fits(self, filename, wavelengths=None, flux_unit=None, area=None,
             If not a Quantity, assumed to be in Angstrom.
             If `None`, ``self.waveset`` is used.
 
-        flux_unit : str, `~astropy.units.core.Unit`, or `None`
+        flux_unit : str, `~astropy.units.Unit`, or `None`
             Flux is converted to this unit before written out.
             If not given, internal unit is used.
 
@@ -1485,7 +1485,7 @@ def check_overlap(self, other, wavelengths=None, threshold=0.01):
         wavelengths : array-like, `~astropy.units.quantity.Quantity`, or `None`
             Wavelength values for integration.
             If not a Quantity, assumed to be in Angstrom.
-            If `None`, `waveset` is used.
+            If `None`, ``waveset`` is used.
 
         threshold : float
             If less than this fraction of flux or throughput falls
@@ -1799,7 +1799,7 @@ def equivwidth(self, **kwargs):
         Parameters
         ----------
         kwargs : dict
-            See :meth:`integrate`.
+            See :meth:``integrate``.
 
         Returns
         -------

synphot/units.py

@@ -161,7 +161,7 @@ def convert_flux(wavelengths, fluxes, out_flux_unit, **kwargs):
     fluxes : array-like or `~astropy.units.quantity.Quantity`
         Flux values. If not a Quantity, assumed to be in PHOTLAM.
 
-    out_flux_unit : str or `~astropy.units.core.Unit`
+    out_flux_unit : str or `~astropy.units.Unit`
         Output flux unit.
 
     area : float or `~astropy.units.quantity.Quantity`
@@ -181,7 +181,7 @@ def convert_flux(wavelengths, fluxes, out_flux_unit, **kwargs):
 
     Raises
     ------
-    astropy.units.core.UnitsError
+    astropy.units.UnitsError
         Conversion failed.
 
     synphot.exceptions.SynphotError
@@ -298,12 +298,12 @@ def validate_unit(input_unit):
 
     Parameters
     ----------
-    input_unit : str or `~astropy.units.core.Unit`
+    input_unit : str or `~astropy.units.Unit`
         Unit to validate.
 
     Returns
     -------
-    output_unit : `~astropy.units.core.Unit`
+    output_unit : `~astropy.units.Unit`
         Validated unit.
 
     Raises
@@ -348,7 +348,7 @@ def validate_unit(input_unit):
     else:
         raise exceptions.SynphotError(
             '{0} must be a recognized string or '
-            'astropy.units.core.Unit'.format(input_unit))
+            'astropy.units.Unit'.format(input_unit))
 
     return output_unit
 
@@ -379,7 +379,7 @@ def validate_quantity(input_value, output_unit, equivalencies=[]):
         Quantity to validate. If not a Quantity, assumed to be
         already in output unit.
 
-    output_unit : str or `~astropy.units.core.Unit`
+    output_unit : str or `~astropy.units.Unit`
         Output quantity unit.
 
     equivalencies : list of equivalence pairs, optional

synphot/utils.py

@@ -165,7 +165,7 @@ def generate_wavelengths(minwave=500, maxwave=26000, num=10000, delta=None,
         If `True`, the wavelength values are evenly spaced in log scale.
         Otherwise, spacing is linear.
 
-    wave_unit : str or `~astropy.units.core.Unit`
+    wave_unit : str or `~astropy.units.Unit`
         Wavelength unit. Default is Angstrom.
 
     Returns