From 735f68180f1def126164544aa1b67d3559224872 Mon Sep 17 00:00:00 2001 From: Ricky O'Steen Date: Tue, 23 Apr 2024 16:01:36 -0400 Subject: [PATCH] Add skips to automodapi --- docs/spectral_regions.rst | 12 +++++++----- docs/spectrum1d.rst | 2 ++ docs/spectrum_collection.rst | 2 ++ 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/spectral_regions.rst b/docs/spectral_regions.rst index 2ca846fba..8990346e3 100644 --- a/docs/spectral_regions.rst +++ b/docs/spectral_regions.rst @@ -150,9 +150,9 @@ Region Extraction Given a `~specutils.SpectralRegion`, one can extract a sub-spectrum from a `~specutils.Spectrum1D` object. If the `~specutils.SpectralRegion` -has multiple sub-regions then by default a list of `~specutils.Spectrum1D` objects -will be returned. If the ``return_single_spectrum`` argument is set to ``True``, -the resulting spectra will be concatenated together into a single +has multiple sub-regions then by default a list of `~specutils.Spectrum1D` objects +will be returned. If the ``return_single_spectrum`` argument is set to ``True``, +the resulting spectra will be concatenated together into a single `~specutils.Spectrum1D` object instead. An example of a single sub-region `~specutils.SpectralRegion`: @@ -240,8 +240,8 @@ in between disjointed spectral regions, can be extracted with 22., 23., 24., 25., 26., 27., 28., 29., 30.] nm> -`~specutils.manipulation.spectral_slab` is basically an alternate entry point for -`~specutils.manipulation.extract_region`. Notice the slightly different way to input the spectral +`~specutils.manipulation.spectral_slab` is basically an alternate entry point for +`~specutils.manipulation.extract_region`. Notice the slightly different way to input the spectral axis range to be extracted. This function's purpose is to facilitate migration of ``spectral_cube`` functionality into ``specutils``: @@ -315,6 +315,8 @@ Reference/API :no-inheritance-diagram: :skip: test + :skip: QTable + :skip: cached_property :skip: Spectrum1D :skip: SpectrumCollection :skip: SpectralAxis diff --git a/docs/spectrum1d.rst b/docs/spectrum1d.rst index f844a5fe5..9bafa1dc8 100644 --- a/docs/spectrum1d.rst +++ b/docs/spectrum1d.rst @@ -386,5 +386,7 @@ Reference/API :headings: -~ :skip: test + :skip: QTable + :skip: cached_property :skip: SpectrumCollection :skip: SpectralRegion diff --git a/docs/spectrum_collection.rst b/docs/spectrum_collection.rst index 52a736a8d..ea02aed59 100644 --- a/docs/spectrum_collection.rst +++ b/docs/spectrum_collection.rst @@ -106,6 +106,8 @@ Reference/API :no-inheritance-diagram: :skip: test + :skip: QTable + :skip: cached_property :skip: Spectrum1D :skip: SpectralRegion :skip: SpectralAxis