diff --git a/docs/conf.py b/docs/conf.py index a2fcece..f81b3d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,6 +44,7 @@ extensions = [ + 'sphinx.ext.todo', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', diff --git a/scopesim_templates/extragalactic/galaxies.py b/scopesim_templates/extragalactic/galaxies.py index 82517dd..a14b1ea 100644 --- a/scopesim_templates/extragalactic/galaxies.py +++ b/scopesim_templates/extragalactic/galaxies.py @@ -340,8 +340,8 @@ def elliptical(r_eff, pixel_scale, filter_name, amplitude, - an EmissionCurve with a user defined spectrum - Optional Parameters (passed to ``sersic_profile``) - -------------------------------------------------- + Other Parameters + ---------------- n : float, optional Default = 4. Sersic index - n=1 for exponential (spiral), diff --git a/scopesim_templates/misc/misc.py b/scopesim_templates/misc/misc.py index b2e6aef..31f79d3 100644 --- a/scopesim_templates/misc/misc.py +++ b/scopesim_templates/misc/misc.py @@ -181,7 +181,7 @@ def source_from_imagehdu(image_hdu, filter_name, pixel_unit_amplitude=None, ... filter_name=filter_name, ... pixel_unit_amplitude=20*u.Jy) - TODO: Check if the image_hdu has WCS + .. todo:: Check if the image_hdu has WCS """ if filter_name is None and waverange is None: raise ValueError("Wavelength information must be given with either a " @@ -351,7 +351,7 @@ def source_from_file(filename, pixel_scale, sed, amplitude, filter_curve, """ Create a source from a fits image. - TODO: Pass the header (or the WCS) to the source object + .. todo:: Pass the header (or the WCS) to the source object Parameters ---------- @@ -388,8 +388,9 @@ def source_from_cube(cube, ext=1) -> Source: In the future more checks will be performed to translate most cubes into a suitable format. - TODO: Set the cube to a different flux level and different pixel scales. - Redshift the cube + .. todo:: + Set the cube to a different flux level and different pixel scales. + Redshift the cube Parameters ---------- diff --git a/scopesim_templates/stellar/clusters.py b/scopesim_templates/stellar/clusters.py index 62d9e2c..675fb60 100644 --- a/scopesim_templates/stellar/clusters.py +++ b/scopesim_templates/stellar/clusters.py @@ -24,9 +24,9 @@ def cluster(mass=1E3, distance=50000, core_radius=1, ra=RA0, dec=DEC0, Generate a source object for a young cluster. The cluster distribution follows a gaussian profile with the - ``core_radius`` corresponding to the HWHM of the distribution. The + `core_radius` corresponding to the HWHM of the distribution. The choice of stars follows a Kroupa IMF, with no evolved stars in the mix. - Ergo this is more suitable for a young cluster than an evolved custer + Ergo this is more suitable for a young cluster than an evolved cluster Parameters @@ -42,8 +42,8 @@ def cluster(mass=1E3, distance=50000, core_radius=1, ra=RA0, dec=DEC0, dec : float, str DEC of the source - Additional parameters - --------------------- + Other Parameters + ---------------- tidal_radius : float [pc] Not yet implemented, for later once there is a King profile multiplicity : Unknown