Update docs for rio-pmtiles (#564)

* `rio-pmtiles` docs:  update defaults from code for tile size, format & resampling.  Src:  `rio_pmtiles/scripts/cli.py`.   Tested with v1.0.0 + local GeoTIFF

* fix Bug in `rio-pmtiles` docs:  `--name` flag did not work.   Changed to what source code (cli.py) accepts

* Updating the docs for the flag `--description` to match the help note from `cli.py` Line 122
This commit is contained in:
Rob Labs
2025-04-30 04:12:13 -07:00
committed by GitHub
parent ca8cd48330
commit ef4f1b9d90

View File

@@ -45,13 +45,13 @@ Usage
-o, --output PATH Path to output file (optional alternative to -o, --output PATH Path to output file (optional alternative to
a positional arg). a positional arg).
--title TEXT PMTiles dataset title. --name TEXT PMTiles metadata name.
--description TEXT PMTiles dataset description. --description TEXT PMTiles metadata description.
--overlay Export as an overlay (the default). --overlay Export as an overlay (the default).
--baselayer Export as a base layer. --baselayer Export as a base layer.
-f, --format [JPEG|PNG|WEBP] Tile image format. -f, --format [JPEG|PNG|WEBP] Tile image format. [default: WEBP]
--tile-size INTEGER Width and height of individual square tiles --tile-size INTEGER Width and height of individual square tiles
to create. [default: 256] to create. [default: 512]
--zoom-levels MIN..MAX A min...max range of export zoom levels. The --zoom-levels MIN..MAX A min...max range of export zoom levels. The
default zoom level is the one at which the default zoom level is the one at which the
@@ -64,7 +64,7 @@ Usage
--dst-nodata FLOAT Manually override destination nodata --dst-nodata FLOAT Manually override destination nodata
--resampling [nearest|bilinear|cubic|cubic_spline|lanczos|average|mode|gauss|max|min|med|q1|q3|rms] --resampling [nearest|bilinear|cubic|cubic_spline|lanczos|average|mode|gauss|max|min|med|q1|q3|rms]
Resampling method to use. [default: Resampling method to use. [default:
nearest] bilinear]
--version Show the version and exit. --version Show the version and exit.
--rgba Select RGBA output. For PNG or WEBP only. --rgba Select RGBA output. For PNG or WEBP only.