0.1.2 doc updates

Author: ATL2001

.gitignore

@@ -10,4 +10,5 @@ wheels/
 .venv
 
 # place for working on stuff
-junk_drawer/
+junk_drawer/
+site/

README.md

@@ -7,6 +7,9 @@ Spatial polars uses [lonboard](https://developmentseed.org/lonboard/latest/) for
 
 Spatial polars is mostly just glue code connecting the work of others to bring spatial funcitonality to polars.
 
+## Documentation
+Documentation can be found here: [https://atl2001.github.io/spatial_polars/](https://atl2001.github.io/spatial_polars/)
+
 ## Lazily access data
 Spatial polars scan_spatial function will scan geoparquet files and any other data source [supported by pyogrio](https://pyogrio.readthedocs.io/en/latest/supported_formats.html) and return a polars lazy frame.  A read_spatial function is also provided which simply wraps scan_spatial with a .collect() at the end to return a polars dataframe. The scan_spatial function was the reason this package was created, it is much preferred over the read_spatial function for [the same reasons that polars recommends](https://docs.pola.rs/user-guide/lazy/using/) using the lazy API over the eager API.
 

docs/index.md

@@ -9,9 +9,18 @@ Spatial polars is mostly just glue code connecting the work of others to bring s
 
 ## Installation
 Spatial polars can be installed from pypi
-```
+```title="Install with no optional dependencies"
 pip install spatial-polars
 ```
+```title="Install with dependencies for displaying data on a lonboard map"
+pip install spatial-polars[lonboard]
+```
+```title="Install with dependencies to run examples in this guide (installs geodatasets)"
+pip install spatial-polars[examples]
+```
+```title="Install with all optional dependencies"
+pip install spatial-polars[lonboard, examples]
+```
 
 ## Lazily access geospatial data
 Spatial polars [scan_spatial](io.md#spatial_polars.io.scan_spatial) function will scan geoparquet files and any other data source [supported by pyogrio](https://pyogrio.readthedocs.io/en/latest/supported_formats.html) and return a [polars LazyFrame](https://docs.pola.rs/api/python/stable/reference/lazyframe/index.html#). A [read_spatial](io.md#spatial_polars.io.read_spatial) function is also provided which simply wraps scan_spatial with a [.collect(streaming=True)][polars.LazyFrame.collect] at the end to return a polars dataframe. The scan_spatial function was the reason this package was created, it is much preferred over the read_spatial function for [the same reasons that polars recommends](https://docs.pola.rs/user-guide/concepts/lazy-api/) using the lazy API over the eager API.

mkdocs.yml

@@ -21,7 +21,7 @@ theme:
     repo: fontawesome/brands/github
     logo: fontawesome/solid/globe  
 
-repo_url: https://github.com/ATL2001/ATL2001/spatial-polars
+repo_url: https://github.com/ATL2001/spatial_polars
 
 plugins:
   - search

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "spatial-polars"
-version = "0.1.1"
+version = "0.1.2" # dont forget __init__.py and uv lock
 description = "A package that extends polars for working with geospatial data."
 readme = "README.md"
 authors = [

src/spatial_polars/__init__.py

@@ -12,4 +12,4 @@
     "SpatialExpr",
 ]
 
-__version__ = "0.1.1"
+__version__ = "0.1.2" # dont forget pyproject.toml and uv lock