Skip to content

Commit 21209ff

Browse files
authored
remove: specficiation documents (#120)
* remove: specficiation documents * fix: skip vcr tests for python 3.9
1 parent c3b7c32 commit 21209ff

File tree

14 files changed

+203
-340
lines changed

14 files changed

+203
-340
lines changed

.github/workflows/continuous-integration.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,3 @@ jobs:
3333
run: uv run pytest tests -v
3434
- name: Check docs
3535
run: uv run mkdocs build --strict
36-
- name: Check jsonschema
37-
run: check-jsonschema --schemafile spec/json-schema/metadata.json spec/example-metadata.json

README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ While STAC Items are commonly distributed as individual JSON files on object sto
1414

1515
For analytic questions like "find the items in the Sentinel-2 collection in June 2024 over New York City with cloud cover of less than 20%" it can be much, much faster to find the relevant data from a GeoParquet source than from JSON, because GeoParquet needs to load only the relevant columns for that query, not the full data.
1616

17-
See the [STAC-GeoParquet specification](./spec/stac-geoparquet-spec.md) for details on the exact schema of the written Parquet files.
18-
17+
See the [STAC-GeoParquet specification](https://radiantearth.github.io/stac-geoparquet-spec/) for details on the exact schema of the written Parquet files.
1918

2019
## Installation
2120

@@ -40,9 +39,3 @@ uv run pre-commit install
4039
uv run pytest
4140
scripts/lint
4241
```
43-
44-
Validate the example collection metadata against the jsonschema:
45-
46-
```shell
47-
check-jsonschema --schemafile spec/json-schema/metadata.json spec/example-metadata.json
48-
```

docs/drawbacks.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/schema.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

docs/spec/stac-geoparquet-spec.md

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

mkdocs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,13 @@ extra:
1717
nav:
1818
- index.md
1919
- usage.md
20-
- schema.md
2120
- Examples:
2221
- examples/naip.ipynb
2322
- examples/dump_pgstac_to_parquet.ipynb
24-
- Specification: spec/stac-geoparquet-spec.md
2523
- API Reference:
2624
- api/arrow.md
2725
- Legacy: api/legacy.md
2826
- api/pgstac.md
29-
- drawbacks.md
3027
- Release Notes: whatsnew.md
3128

3229
watch:
@@ -109,6 +106,11 @@ plugins:
109106
- https://pandas.pydata.org/pandas-docs/stable/objects.inv
110107
- https://pystac.readthedocs.io/en/stable/objects.inv
111108
- https://shapely.readthedocs.io/en/stable/objects.inv
109+
- redirects:
110+
redirect_maps:
111+
"spec/stac-geoparquet-spec.md": "https://radiantearth.github.io/stac-geoparquet-spec/latest/"
112+
"drawbacks.md": "https://radiantearth.github.io/stac-geoparquet-spec/latest/drawbacks/"
113+
"schema.md": "https://radiantearth.github.io/stac-geoparquet-spec/latest/schema/"
112114

113115
# https://github.com/developmentseed/titiler/blob/50934c929cca2fa8d3c408d239015f8da429c6a8/docs/mkdocs.yml#L115-L140
114116
markdown_extensions:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ docs = [
6262
"mkdocs-material[imaging]>=9.5",
6363
"mkdocs",
6464
"mkdocstrings[python]>=0.25.1",
65+
"mkdocs-redirects>=1.2.2",
6566
]
6667

6768
[tool.uv]

spec/example-metadata.json

Lines changed: 0 additions & 42 deletions
This file was deleted.

spec/json-schema/metadata.json

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)