Skip to content

Commit

Permalink
Update docs root page (#905)
Browse files Browse the repository at this point in the history
Closes #774
  • Loading branch information
kylebarron authored Dec 5, 2024
1 parent 5a6b1cf commit cd7a238
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 10 deletions.
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ To deploy: We have a couple manual steps because `mkdocs gh-deploy` _replaces_
any existing content on the `gh-pages` branch and we want an _upsert_ that
doesn't touch the `js/` or `python/` directories, which are deployed separately.

```
```bash
uv run mkdocs build
git checkout gh-pages
mv site/* ../
cd ..
rm -rf 404.html assets index.html sitemap.xml sitemap.xml.gz search stylesheets
mv -f docs/site/* ./
git add 404.html assets index.html sitemap.xml sitemap.xml.gz search stylesheets
git commit -m "New revision of top-level docs site"
git push
# Return to previous branch
git checkout -
```
11 changes: 5 additions & 6 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# `geoarrow-rs`

A Rust implementation and Python and JavaScript (WebAssembly) bindings of the [GeoArrow](https://geoarrow.org) memory specification for efficiently storing geospatial vector geometries, connected to geospatial algorithms implemented by the [GeoRust community](https://georust.org/).

## Motivation

GeoArrow provides a way to share geospatial vector data between programs _at no cost_ and without copies, so that an ecosystem of libraries can share data without serialization overhead. Removing this overhead enables faster code in high-level, interpreted languages such as Python and JavaScript.

The geoarrow-rs repository contains a Rust implementation, Python bindings, and JavaScript (WebAssembly) bindings of the [GeoArrow](https://geoarrow.org) memory specification for efficiently storing geospatial vector geometries, connected to geospatial algorithms implemented by the [GeoRust community](https://georust.org/).

<div class="grid cards" markdown>

Expand Down Expand Up @@ -42,3 +37,7 @@ GeoArrow provides a way to share geospatial vector data between programs _at no
[:octicons-arrow-right-24: Specification](https://geoarrow.org)

</div>

## Motivation

GeoArrow provides a way to share geospatial vector data between programs _at no cost_ and without copies, so that an ecosystem of libraries can share data without serialization overhead. Removing this overhead enables faster code in high-level, interpreted languages such as Python and JavaScript.
4 changes: 2 additions & 2 deletions docs/source/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
--md-primary-fg-color: #dea584;
--md-primary-bg-color: #1f292d;
--md-primary-fg-color--light: #f9c6a9;
--md-primary-fg-color--dark: #c28a6a;
--md-primary-fg-color--dark: #c28a6a;
}

/* Override just a couple colors from slate */
[data-md-color-scheme="slate"] {
--md-primary-fg-color: #dea584;
--md-primary-bg-color: #1f292d;
--md-primary-fg-color--light: #f9c6a9;
--md-primary-fg-color--dark: #c28a6a;
--md-primary-fg-color--dark: #c28a6a;
}

0 comments on commit cd7a238

Please sign in to comment.