Skip to content

Commit ad261ce

Browse files
committed
docs: make custom doc home page
1 parent ebea498 commit ad261ce

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

docs/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# rustac
2+
3+
> The power of Rust for the Python STAC ecosystem.
4+
5+
**rustac** is a zero-dependency Python package for [STAC](https://stacspec.org/) using Rust under the hood.
6+
7+
## Installation
8+
9+
```shell
10+
python -m pip install rustac
11+
```
12+
13+
If you'd like to use `arrow` tables, e.g. to load into GeoPandas:
14+
15+
```shell
16+
python -m pip install 'rustac[arrow]'
17+
```
18+
19+
## Usage
20+
21+
```python
22+
import rustac.blocking
23+
24+
item = rustac.blocking.read("item.json")
25+
26+
# Or, for async
27+
import asyncio
28+
import rustac
29+
30+
def main() -> None:
31+
item = await rustac.read("item.json")
32+
33+
asyncio.run(main())
34+
```
35+
36+
For more, see our [examples](./generated/gallery/index.md).

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
site_name: rustac-py
2-
site_description: A small no-dependency Python package for STAC, using Rust under the hood.
1+
site_name: rustac
2+
site_description: The power of Rust for the Python STAC ecosystem
33
site_url: https://stac-utils.github.io/rustac-py
44
repo_url: https://github.com/stac-utils/rustac-py
55
theme:

0 commit comments

Comments
 (0)