From 396d44dd492d83251102614c76c0bc4b85b8352c Mon Sep 17 00:00:00 2001 From: Peter Williams Date: Wed, 13 Oct 2021 13:23:48 -0400 Subject: [PATCH] Fix up docs build for recent changes For some reason I can't get a reference to `toasty.image.SUPPORTED_FORMATS` to work as a Sphinx `:data:...` reference? --- docs/api/toasty.image.ImageMode.rst | 2 ++ ...asty.samplers.ChunkedPlateCareeSampler.rst | 29 +++++++++++++++++++ .../toasty.toast.ToastCoordinateSystem.rst | 19 ++++++++++++ ...asty.toast.count_tiles_matching_filter.rst | 6 ++++ docs/api/toasty.toast.create_single_tile.rst | 6 ++++ .../toasty.toast.generate_tiles_filtered.rst | 6 ++++ .../toasty.toast.toast_tile_get_coords.rst | 6 ++++ toasty/builder.py | 4 +-- toasty/toast.py | 6 ++-- 9 files changed, 79 insertions(+), 5 deletions(-) create mode 100644 docs/api/toasty.samplers.ChunkedPlateCareeSampler.rst create mode 100644 docs/api/toasty.toast.ToastCoordinateSystem.rst create mode 100644 docs/api/toasty.toast.count_tiles_matching_filter.rst create mode 100644 docs/api/toasty.toast.create_single_tile.rst create mode 100644 docs/api/toasty.toast.generate_tiles_filtered.rst create mode 100644 docs/api/toasty.toast.toast_tile_get_coords.rst diff --git a/docs/api/toasty.image.ImageMode.rst b/docs/api/toasty.image.ImageMode.rst index e8e8550..2289fb1 100644 --- a/docs/api/toasty.image.ImageMode.rst +++ b/docs/api/toasty.image.ImageMode.rst @@ -15,6 +15,7 @@ ImageMode ~ImageMode.F64 ~ImageMode.RGB ~ImageMode.RGBA + ~ImageMode.U8 .. rubric:: Methods Summary @@ -31,6 +32,7 @@ ImageMode .. autoattribute:: F64 .. autoattribute:: RGB .. autoattribute:: RGBA + .. autoattribute:: U8 .. rubric:: Methods Documentation diff --git a/docs/api/toasty.samplers.ChunkedPlateCareeSampler.rst b/docs/api/toasty.samplers.ChunkedPlateCareeSampler.rst new file mode 100644 index 0000000..ce3fe31 --- /dev/null +++ b/docs/api/toasty.samplers.ChunkedPlateCareeSampler.rst @@ -0,0 +1,29 @@ +ChunkedPlateCareeSampler +======================== + +.. currentmodule:: toasty.samplers + +.. autoclass:: ChunkedPlateCareeSampler + :show-inheritance: + + .. rubric:: Attributes Summary + + .. autosummary:: + + ~ChunkedPlateCareeSampler.n_chunks + + .. rubric:: Methods Summary + + .. autosummary:: + + ~ChunkedPlateCareeSampler.filter + ~ChunkedPlateCareeSampler.sampler + + .. rubric:: Attributes Documentation + + .. autoattribute:: n_chunks + + .. rubric:: Methods Documentation + + .. automethod:: filter + .. automethod:: sampler diff --git a/docs/api/toasty.toast.ToastCoordinateSystem.rst b/docs/api/toasty.toast.ToastCoordinateSystem.rst new file mode 100644 index 0000000..4b7d23f --- /dev/null +++ b/docs/api/toasty.toast.ToastCoordinateSystem.rst @@ -0,0 +1,19 @@ +ToastCoordinateSystem +===================== + +.. currentmodule:: toasty.toast + +.. autoclass:: ToastCoordinateSystem + :show-inheritance: + + .. rubric:: Attributes Summary + + .. autosummary:: + + ~ToastCoordinateSystem.ASTRONOMICAL + ~ToastCoordinateSystem.PLANETARY + + .. rubric:: Attributes Documentation + + .. autoattribute:: ASTRONOMICAL + .. autoattribute:: PLANETARY diff --git a/docs/api/toasty.toast.count_tiles_matching_filter.rst b/docs/api/toasty.toast.count_tiles_matching_filter.rst new file mode 100644 index 0000000..3e1aac0 --- /dev/null +++ b/docs/api/toasty.toast.count_tiles_matching_filter.rst @@ -0,0 +1,6 @@ +count_tiles_matching_filter +=========================== + +.. currentmodule:: toasty.toast + +.. autofunction:: count_tiles_matching_filter diff --git a/docs/api/toasty.toast.create_single_tile.rst b/docs/api/toasty.toast.create_single_tile.rst new file mode 100644 index 0000000..3e82567 --- /dev/null +++ b/docs/api/toasty.toast.create_single_tile.rst @@ -0,0 +1,6 @@ +create_single_tile +================== + +.. currentmodule:: toasty.toast + +.. autofunction:: create_single_tile diff --git a/docs/api/toasty.toast.generate_tiles_filtered.rst b/docs/api/toasty.toast.generate_tiles_filtered.rst new file mode 100644 index 0000000..0bada75 --- /dev/null +++ b/docs/api/toasty.toast.generate_tiles_filtered.rst @@ -0,0 +1,6 @@ +generate_tiles_filtered +======================= + +.. currentmodule:: toasty.toast + +.. autofunction:: generate_tiles_filtered diff --git a/docs/api/toasty.toast.toast_tile_get_coords.rst b/docs/api/toasty.toast.toast_tile_get_coords.rst new file mode 100644 index 0000000..c47aeff --- /dev/null +++ b/docs/api/toasty.toast.toast_tile_get_coords.rst @@ -0,0 +1,6 @@ +toast_tile_get_coords +===================== + +.. currentmodule:: toasty.toast + +.. autofunction:: toast_tile_get_coords diff --git a/toasty/builder.py b/toasty/builder.py index 7e477a8..e6371e1 100644 --- a/toasty/builder.py +++ b/toasty/builder.py @@ -85,8 +85,8 @@ class Builder(object): tiling : `toasty.study.StudyTiling` The prepared tiling information - Remarks - ------- + Notes + ----- After calling this method, you should set up the WCS for the tiled imagery, using :meth:`default_tiled_study_astrometry` as a backstop if no real information is available. Then use :meth:`execute_study_tiling` diff --git a/toasty/toast.py b/toasty/toast.py index fea5d93..5ef4d08 100644 --- a/toasty/toast.py +++ b/toasty/toast.py @@ -465,7 +465,7 @@ def create_single_tile(pos, coordsys=ToastCoordinateSystem.ASTRONOMICAL): Parameters ---------- - pos : :class:`Position` + pos : :class:`~toasty.pyramid.Pos` The position of the tile that will be created. The depth of the tile must be at least 1. coordsys : optional :class:`ToastCoordinateSystem` @@ -578,7 +578,7 @@ def count_tiles_matching_filter(depth, filter, bottom_only=True, coordsys=ToastC Notes ----- This function's call signature and tree-exploration semantics match - :func:`generated_tiles_filtered`. + :func:`generate_tiles_filtered`. """ # With a generic filter function, brute force is our only option: n = 0 @@ -617,7 +617,7 @@ def sample_layer( :attr:`ToastCoordinateSystem.ASTRONOMICAL`. format : optional :class:`str` If provided, override the default data storage format of *pio* with the - named format, one of the values in :var:`toasty.image.SUPPORTED_FORMATS`. + named format, one of the values in ``toasty.image.SUPPORTED_FORMATS``. parallel : integer or None (the default) The level of parallelization to use. If unspecified, defaults to using all CPUs. If the OS does not support fork-based multiprocessing,