diff --git a/docs/cli/index.md b/docs/cli/index.md index 0b37c4d3..4ee663f8 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -1,3 +1,7 @@ +--- +description: The stac-rs command-line interface (CLI), stacrs +--- + # Command-line interface (CLI) The **stac-rs** command-line interface can be installed two ways. diff --git a/docs/python/api/index.md b/docs/python/api/index.md index a8ff8993..183229f5 100644 --- a/docs/python/api/index.md +++ b/docs/python/api/index.md @@ -1,3 +1,7 @@ +--- +description: The stacrs Python API +--- + # Python API API documentation for the **stacrs** Python package. diff --git a/docs/python/api/migrate.md b/docs/python/api/migrate.md index 5c350b35..282fb52b 100644 --- a/docs/python/api/migrate.md +++ b/docs/python/api/migrate.md @@ -1,3 +1,7 @@ +--- +description: Migrate STAC to another version +--- + # Migration ::: stacrs.migrate diff --git a/docs/python/api/pystac.md b/docs/python/api/pystac.md index 691f3503..c15a49c3 100644 --- a/docs/python/api/pystac.md +++ b/docs/python/api/pystac.md @@ -1,3 +1,7 @@ +--- +description: Interface with pystac +--- + # pystac These functions are only available if [pystac](https://pystac.readthedocs.io/) is available on your system. diff --git a/docs/python/api/read.md b/docs/python/api/read.md index 5ac76ee5..6dccf09e 100644 --- a/docs/python/api/read.md +++ b/docs/python/api/read.md @@ -1,3 +1,7 @@ +--- +description: Read STAC from the local filesystem or blob storage +--- + # Read ::: stacrs.read diff --git a/docs/python/api/search.md b/docs/python/api/search.md index e13de5e3..7f5fdf42 100644 --- a/docs/python/api/search.md +++ b/docs/python/api/search.md @@ -1,3 +1,7 @@ +--- +description: Search a STAC API +--- + # Search ::: stacrs.search diff --git a/docs/python/api/validate.md b/docs/python/api/validate.md index df2481f3..f9b6a202 100644 --- a/docs/python/api/validate.md +++ b/docs/python/api/validate.md @@ -1,3 +1,7 @@ +--- +description: Validate STAC with json-schema +--- + # Validate ::: stacrs.validate diff --git a/docs/python/api/write.md b/docs/python/api/write.md index 9c18bb2b..44dd89ad 100644 --- a/docs/python/api/write.md +++ b/docs/python/api/write.md @@ -1,3 +1,7 @@ +--- +description: Write STAC to the filesystem or to blob storage +--- + # Write ::: stacrs.write diff --git a/docs/python/index.md b/docs/python/index.md index 3beb8b06..7040921d 100644 --- a/docs/python/index.md +++ b/docs/python/index.md @@ -1,3 +1,7 @@ +--- +description: The stac-rs Python package, stacrs +--- + # stacrs A Python package for working with [STAC](https://stacspec.org) designed to compliment existing packages such as [pystac](https://pystac.readthedocs.io) and [pystac-client](https://pystac-client.readthedocs.io). diff --git a/mkdocs.yml b/mkdocs.yml index a945f1e3..613b6fbd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ site_name: stac-rs +site_description: Command Line Interface (CLI), Rust crates, and other libraries for the SpatioTemporal Asset Catalog (STAC) specification. site_url: https://stac-utils.github.io/stac-rs repo_url: https://github.com/stac-utils/stac-rs theme: @@ -30,7 +31,10 @@ nav: - cli/index.md plugins: - search - - social + - social: + cards_layout_options: + color: rgb(26, 78, 99) + background_color: rgb(228, 246, 251) - mkdocstrings: enable_inventory: true handlers: