Skip to content

Commit

Permalink
Add skips to automodapi
Browse files Browse the repository at this point in the history
  • Loading branch information
rosteen committed Apr 23, 2024
1 parent 890c9f5 commit 735f681
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/spectral_regions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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``:
Expand Down Expand Up @@ -315,6 +315,8 @@ Reference/API
:no-inheritance-diagram:

:skip: test
:skip: QTable
:skip: cached_property
:skip: Spectrum1D
:skip: SpectrumCollection
:skip: SpectralAxis
2 changes: 2 additions & 0 deletions docs/spectrum1d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -386,5 +386,7 @@ Reference/API
:headings: -~

:skip: test
:skip: QTable
:skip: cached_property
:skip: SpectrumCollection
:skip: SpectralRegion
2 changes: 2 additions & 0 deletions docs/spectrum_collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ Reference/API
:no-inheritance-diagram:

:skip: test
:skip: QTable
:skip: cached_property
:skip: Spectrum1D
:skip: SpectralRegion
:skip: SpectralAxis

0 comments on commit 735f681

Please sign in to comment.