Skip to content

Commit 5c86206

Browse files
authored
feat: docs update (#626)
1 parent c54d559 commit 5c86206

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

docs/index.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,39 @@
22

33
![Ferris holding STAC](./img/ferris-holding-stac-small.png)
44

5-
Command Line Interface (CLI) and Rust crates for the [SpatioTemporal Asset Catalog (STAC)](https://stacspec.org/) specification.
5+
Welcome to the home of STAC and Rust.
6+
We're happy you're here.
7+
8+
## What is stac-rs?
9+
10+
**stac-rs** is a [Github repository](https://github.com/stac-utils/stac-rs) that holds the code for several Rust [crates](https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html) that can be used to create, search for, and otherwise work with [STAC](https://stacspec.org).
11+
12+
## What is stacrs?
13+
14+
**stacrs** (notice the lack of a hyphen) is a Python [package](https://pypi.org/project/stacrs/) that provides a simple API for interacting with STAC.
15+
**stacrs** uses the Rust code in **stac-rs** under the hood.
16+
17+
```python
18+
import stacrs
19+
20+
items = stacrs.search("s3://bucket/items.parquet", ...)
21+
```
22+
23+
Check out the [stacrs docs](https://stac-utils.github.io/stacrs) for more.
24+
25+
## Why are the names so confusing?
26+
27+
Because [@gadomski](https://github.com/gadomski/), who built and maintains these tools, is really bad at naming stuff.
28+
29+
## Why are stac-rs and stacrs in two separate repos?
30+
31+
Couple of reasons:
32+
33+
1. **stac-rs** is intended to be useful on its own.
34+
It's not just the engine for some Python bindings.
35+
2. Care-and-feeding for Python wheels built from Rust is a bit finicky.
36+
By moving **stacrs** to its own repo, we're able to separate the concerns of keeping a good, clean Rust core, and building Python wheels.
37+
Not everyone agrees with this strategy, but here we are.
638

739
## Rust documentation on docs.rs
840

mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ plugins:
3939

4040
markdown_extensions:
4141
- admonition
42+
- pymdownx.highlight:
43+
anchor_linenums: true
44+
line_spans: __span
45+
pygments_lang_class: true
46+
- pymdownx.inlinehilite
47+
- pymdownx.snippets
48+
- pymdownx.superfences
49+
- pymdownx.details
4250

4351
extra_css:
4452
- stylesheets/extra.css

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,6 @@ stac-geoparquet = [
1313
"stac-geoparquet>=0.6.0",
1414
]
1515
stac-api-validator = ["setuptools>=75.1.0", "stac-api-validator>=0.6.3"]
16+
17+
[tool.uv]
18+
default-groups = ["docs", "stac-geoparquet", "stac-api-validator"]

0 commit comments

Comments
 (0)