diff --git a/CHANGES.md b/CHANGES.md index cc48da058..01b60594e 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1431,9 +1431,9 @@ Migration doc available at: https://developmentseed.org/titiler/migrations/v2_mi **breaking changes** * remove `timing headers` and `titiler.core.utils` submodule -* remove `asset_expression` (except in `/asset_statistics` endpoint) (see https://cogeotiff.github.io/rio-tiler/v4_migration/#multibasereader-expressions) +* remove `asset_expression` (except in `/asset_statistics` endpoint) (see https://cogeotiff.github.io/rio-tiler/latest/migrations/v4_migration/#multibasereader-expressions) * update Point output model to include `band_names` -* histogram and info band names are prefixed with `b` (e.g `b1`) (ref: https://cogeotiff.github.io/rio-tiler/v4_migration/#band-names) +* histogram and info band names are prefixed with `b` (e.g `b1`) (ref: https://cogeotiff.github.io/rio-tiler/latest/migrations/v4_migration/#band-names) * add `/map` endpoint in TilerFactory to display tiles given query-parameters * remove `TMSParams` and `WebMercatorTMSParams` dependencies. * replace `TilerFactory.tms_dependency` attribute by `TilerFactory.supported_tms`. This attribute gets a `morecantile.defaults.TileMatrixSets` store and will create the tms dependencies dynamically diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 19911e097..95f464ea9 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -180,7 +180,7 @@ plugins: - https://rasterio.readthedocs.io/en/stable/objects.inv - https://docs.pydantic.dev/latest/objects.inv - https://fastapi.tiangolo.com/objects.inv - - https://cogeotiff.github.io/rio-tiler/objects.inv + - https://cogeotiff.github.io/rio-tiler/latest/objects.inv theme: name: material diff --git a/docs/src/advanced/endpoints_factories.md b/docs/src/advanced/endpoints_factories.md index 853a2c9ec..cae6b8954 100644 --- a/docs/src/advanced/endpoints_factories.md +++ b/docs/src/advanced/endpoints_factories.md @@ -3,7 +3,7 @@ TiTiler's endpoints factories are helper functions that let users create a FastA !!! Important - Most of `tiler` **Factories** are built around [`rio_tiler.io.BaseReader`](https://cogeotiff.github.io/rio-tiler/advanced/custom_readers/), which defines basic methods to access datasets (e.g COG or STAC). The default reader is `Reader` for `TilerFactory` and `MosaicBackend` for `MosaicTilerFactory`. + Most of `tiler` **Factories** are built around [`rio_tiler.io.BaseReader`](https://cogeotiff.github.io/rio-tiler/latest/advanced/custom_readers/), which defines basic methods to access datasets (e.g COG or STAC). The default reader is `Reader` for `TilerFactory` and `MosaicBackend` for `MosaicTilerFactory`. Factories classes use [dependencies injection](dependencies.md) to define most of the endpoint options. @@ -35,7 +35,7 @@ Most **Factories** are built from this [abstract based class](https://docs.pytho class: `titiler.core.factory.TilerFactory` -Factory meant to create endpoints for single dataset using [*rio-tiler*'s `Reader`](https://cogeotiff.github.io/rio-tiler/readers/#rio_tileriorasterioreader). +Factory meant to create endpoints for single dataset using [*rio-tiler*'s `Reader`](https://cogeotiff.github.io/rio-tiler/latest/readers/#rio_tileriorasterioreader). #### Attributes @@ -105,7 +105,7 @@ app.include_router(cog.router) class: `titiler.core.factory.MultiBaseTilerFactory` -Custom `TilerFactory` to be used with [`rio_tiler.io.MultiBaseReader`](https://cogeotiff.github.io/rio-tiler/advanced/custom_readers/#multibasereader) type readers (e.g [`rio_tiler.io.STACReader`](https://cogeotiff.github.io/rio-tiler/readers/#rio_tileriostacstacreader)). +Custom `TilerFactory` to be used with [`rio_tiler.io.MultiBaseReader`](https://cogeotiff.github.io/rio-tiler/latest/advanced/custom_readers/#multibasereader) type readers (e.g [`rio_tiler.io.STACReader`](https://cogeotiff.github.io/rio-tiler/latest/readers/#rio_tileriostacstacreader)). #### Attributes diff --git a/docs/src/examples/code/tiler_with_custom_stac+xarray.md b/docs/src/examples/code/tiler_with_custom_stac+xarray.md index 112407a6c..10ca4f45a 100644 --- a/docs/src/examples/code/tiler_with_custom_stac+xarray.md +++ b/docs/src/examples/code/tiler_with_custom_stac+xarray.md @@ -13,7 +13,7 @@ **links**: -- https://cogeotiff.github.io/rio-tiler/examples/STAC_datacube_support/ +- https://cogeotiff.github.io/rio-tiler/latest/examples/STAC_datacube_support/ #### 1. Custom STACReader diff --git a/docs/src/examples/notebooks/Working_with_CloudOptimizedGeoTIFF_simple.ipynb b/docs/src/examples/notebooks/Working_with_CloudOptimizedGeoTIFF_simple.ipynb index b144e5803..23c78a426 100644 --- a/docs/src/examples/notebooks/Working_with_CloudOptimizedGeoTIFF_simple.ipynb +++ b/docs/src/examples/notebooks/Working_with_CloudOptimizedGeoTIFF_simple.ipynb @@ -254,7 +254,7 @@ "source": [ "Apply non-linear colormap (intervals)\n", "\n", - "see https://cogeotiff.github.io/rio-tiler/colormap/#intervals-colormaps" + "see https://cogeotiff.github.io/rio-tiler/latest/colormap/#intervals-colormaps" ] }, { diff --git a/docs/src/user_guide/algorithms.md b/docs/src/user_guide/algorithms.md index 187450e08..54e77d825 100644 --- a/docs/src/user_guide/algorithms.md +++ b/docs/src/user_guide/algorithms.md @@ -92,7 +92,7 @@ class BaseAlgorithm(BaseModel, metaclass=abc.ABCMeta): This base class defines that algorithm: -- **HAVE TO** implement an `__call__` method which takes an [ImageData](https://cogeotiff.github.io/rio-tiler/models/#imagedata) as input and return an [ImageData](https://cogeotiff.github.io/rio-tiler/models/#imagedata). Using `__call__` let us use the object as a callable (e.g `Algorithm(**kwargs)(image)`). +- **HAVE TO** implement an `__call__` method which takes an [ImageData](https://cogeotiff.github.io/rio-tiler/latest/models/#imagedata) as input and return an [ImageData](https://cogeotiff.github.io/rio-tiler/latest/models/#imagedata). Using `__call__` let us use the object as a callable (e.g `Algorithm(**kwargs)(image)`). - can have input/output metadata (informative) diff --git a/docs/src/user_guide/rendering.md b/docs/src/user_guide/rendering.md index 1c18f9f7a..735be03bd 100644 --- a/docs/src/user_guide/rendering.md +++ b/docs/src/user_guide/rendering.md @@ -18,7 +18,7 @@ TiTiler supports both default colormaps (each with a name) and custom color maps Default colormaps pre-made, each with a given name. These maps come from the `rio-tiler` library, which has taken colormaps packaged with Matplotlib and has added others that are commonly used with raster data. -A list of available color maps can be found in Titiler's Swagger docs, or in the [rio-tiler documentation](https://cogeotiff.github.io/rio-tiler/colormap/#default-rio-tilers-colormaps). +A list of available color maps can be found in Titiler's Swagger docs, or in the [rio-tiler documentation](https://cogeotiff.github.io/rio-tiler/latest/colormap/#default-rio-tilers-colormaps). To use a default colormap, simply use the parameter `colormap_name`: @@ -61,7 +61,7 @@ response = httpx.get( TiTiler supports colormaps that are both discrete (where pixels will be one of the colors that you specify) and linear (where pixel colors will blend between the given colors). -For more information, please check out [rio-tiler's docs](https://cogeotiff.github.io/rio-tiler/colormap/). +For more information, please check out [rio-tiler's docs](https://cogeotiff.github.io/rio-tiler/latest/colormap/). It is also possible to add a [colormap dependency](../examples/code/tiler_with_custom_colormap) to automatically apply a default colormap. diff --git a/src/titiler/mosaic/README.md b/src/titiler/mosaic/README.md index 72113a72e..97388a3bc 100644 --- a/src/titiler/mosaic/README.md +++ b/src/titiler/mosaic/README.md @@ -2,7 +2,7 @@ -Adds support for Mosaic in Titiler. `Mosaic's` backend needs to be built on top of rio-tiler's Mosaic Backend https://cogeotiff.github.io/rio-tiler/advanced/mosaic_backend/ +Adds support for Mosaic in Titiler. `Mosaic's` backend needs to be built on top of rio-tiler's Mosaic Backend https://cogeotiff.github.io/rio-tiler/latest/advanced/mosaic_backend/ ## Installation