diff --git a/docs/_static/custom.css b/docs/_static/custom.css index f376c53..ea68acf 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,3 +1,5 @@ +@import "../basic.css"; + :root { - --pst-font-size-base: 12px; + --pst-font-size-base: 14px; } diff --git a/docs/conf.py b/docs/conf.py index 5701515..6cf5845 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,8 +27,9 @@ ] html_theme = "pydata_sphinx_theme" +html_static_path = ["_static"] html_css_files = [ - "css/custom.css", + "custom.css", ] intersphinx_mapping = { diff --git a/src/pyia/data.py b/src/pyia/data.py index 73c6e53..5e3a73e 100644 --- a/src/pyia/data.py +++ b/src/pyia/data.py @@ -91,9 +91,9 @@ class GaiaData: - """Class for loading and interacting with data from the Gaia mission. This - should work with data from any data release, i.e., DR1 gaia_source or TGAS, - or DR2, EDR3, DR3 gaia_source tables. + """The main class for loading and interacting with data from the Gaia mission. This + should work with Gaia catalog data from any data release, i.e., DR1 gaia_source or + TGAS, or DR2, EDR3, DR3 gaia_source tables. Parameters ---------- @@ -444,7 +444,7 @@ def get_pm( Returns ------- - astropy.units.Quantity + :class:`~astropy.units.Quantity` A 2D array of proper motion values in the specified frame. """ if frame == "icrs" or isinstance(frame, coord.ICRS): @@ -531,7 +531,7 @@ def get_radial_velocity( Returns ------- - :class:`~astropy.units.Quantity` + :class:`~astropy.units.Quantity` [velocity] The radial velocity values. """ if self.radial_velocity_colname != "radial_velocity": @@ -686,7 +686,7 @@ def get_ebv(self, dustmaps_cls: Optional[Any] = None) -> npt.NDArray: def get_ext( self, ebv: Optional[npt.ArrayLike] = None, dustmaps_cls: Optional[Any] = None - ) -> npt.NDArray: + ) -> Tuple[u.Quantity[u.mag], u.Quantity[u.mag], u.Quantity[u.mag]]: """Compute the E(B-V) reddening at this location This requires the `dustmaps `_ package @@ -753,7 +753,7 @@ def get_uwe(self) -> u.Quantity: """Compute and return the unit-weight error.""" return np.sqrt(self.astrometric_chi2_al / (self.astrometric_n_good_obs_al - 5)) - def get_ruwe(self) -> npt.NDArray: + def get_ruwe(self) -> None: msg = ( "Use the Gaia DR3 RUWE value instead. This can be accessed with the `.ruwe`" " attribute if it is present in the data table."