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?
This commit is contained in:
Родитель
c5bf5abb2c
Коммит
396d44dd49
|
@ -15,6 +15,7 @@ ImageMode
|
||||||
~ImageMode.F64
|
~ImageMode.F64
|
||||||
~ImageMode.RGB
|
~ImageMode.RGB
|
||||||
~ImageMode.RGBA
|
~ImageMode.RGBA
|
||||||
|
~ImageMode.U8
|
||||||
|
|
||||||
.. rubric:: Methods Summary
|
.. rubric:: Methods Summary
|
||||||
|
|
||||||
|
@ -31,6 +32,7 @@ ImageMode
|
||||||
.. autoattribute:: F64
|
.. autoattribute:: F64
|
||||||
.. autoattribute:: RGB
|
.. autoattribute:: RGB
|
||||||
.. autoattribute:: RGBA
|
.. autoattribute:: RGBA
|
||||||
|
.. autoattribute:: U8
|
||||||
|
|
||||||
.. rubric:: Methods Documentation
|
.. rubric:: Methods Documentation
|
||||||
|
|
||||||
|
|
|
@ -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
|
|
@ -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
|
|
@ -0,0 +1,6 @@
|
||||||
|
count_tiles_matching_filter
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. currentmodule:: toasty.toast
|
||||||
|
|
||||||
|
.. autofunction:: count_tiles_matching_filter
|
|
@ -0,0 +1,6 @@
|
||||||
|
create_single_tile
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. currentmodule:: toasty.toast
|
||||||
|
|
||||||
|
.. autofunction:: create_single_tile
|
|
@ -0,0 +1,6 @@
|
||||||
|
generate_tiles_filtered
|
||||||
|
=======================
|
||||||
|
|
||||||
|
.. currentmodule:: toasty.toast
|
||||||
|
|
||||||
|
.. autofunction:: generate_tiles_filtered
|
|
@ -0,0 +1,6 @@
|
||||||
|
toast_tile_get_coords
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. currentmodule:: toasty.toast
|
||||||
|
|
||||||
|
.. autofunction:: toast_tile_get_coords
|
|
@ -85,8 +85,8 @@ class Builder(object):
|
||||||
tiling : `toasty.study.StudyTiling`
|
tiling : `toasty.study.StudyTiling`
|
||||||
The prepared tiling information
|
The prepared tiling information
|
||||||
|
|
||||||
Remarks
|
Notes
|
||||||
-------
|
-----
|
||||||
After calling this method, you should set up the WCS for the tiled
|
After calling this method, you should set up the WCS for the tiled
|
||||||
imagery, using :meth:`default_tiled_study_astrometry` as a backstop if
|
imagery, using :meth:`default_tiled_study_astrometry` as a backstop if
|
||||||
no real information is available. Then use :meth:`execute_study_tiling`
|
no real information is available. Then use :meth:`execute_study_tiling`
|
||||||
|
|
|
@ -465,7 +465,7 @@ def create_single_tile(pos, coordsys=ToastCoordinateSystem.ASTRONOMICAL):
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
pos : :class:`Position`
|
pos : :class:`~toasty.pyramid.Pos`
|
||||||
The position of the tile that will be created. The depth of the
|
The position of the tile that will be created. The depth of the
|
||||||
tile must be at least 1.
|
tile must be at least 1.
|
||||||
coordsys : optional :class:`ToastCoordinateSystem`
|
coordsys : optional :class:`ToastCoordinateSystem`
|
||||||
|
@ -578,7 +578,7 @@ def count_tiles_matching_filter(depth, filter, bottom_only=True, coordsys=ToastC
|
||||||
Notes
|
Notes
|
||||||
-----
|
-----
|
||||||
This function's call signature and tree-exploration semantics match
|
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:
|
# With a generic filter function, brute force is our only option:
|
||||||
n = 0
|
n = 0
|
||||||
|
@ -617,7 +617,7 @@ def sample_layer(
|
||||||
:attr:`ToastCoordinateSystem.ASTRONOMICAL`.
|
:attr:`ToastCoordinateSystem.ASTRONOMICAL`.
|
||||||
format : optional :class:`str`
|
format : optional :class:`str`
|
||||||
If provided, override the default data storage format of *pio* with the
|
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)
|
parallel : integer or None (the default)
|
||||||
The level of parallelization to use. If unspecified, defaults to using
|
The level of parallelization to use. If unspecified, defaults to using
|
||||||
all CPUs. If the OS does not support fork-based multiprocessing,
|
all CPUs. If the OS does not support fork-based multiprocessing,
|
||||||
|
|
Загрузка…
Ссылка в новой задаче