Improved docs (#8)

* Improve docs

* Update branch name in docs-build.yml

* Add codespell

Author: giswqs

.github/workflows/docs-build.yml

@@ -0,0 +1,48 @@
+name: docs-build
+on:
+    pull_request:
+        branches:
+            - main
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: "3.10"
+            - name: Install GDAL
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --find-links=https://girder.github.io/large_image_wheels --no-cache GDAL pyproj
+            - name: Test GDAL installation
+              run: |
+                  python -c "from osgeo import gdal"
+                  gdalinfo --version
+            - name: Install dependencies
+              run: |
+                  pip install --no-cache-dir Cython
+                  pip install -r requirements.txt -r requirements_dev.txt -r requirements_docs.txt
+                  pip install .
+            - name: Discover typos with codespell
+              run: codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,*.pdf" --ignore-words-list="aci,acount,acounts,fallow,hart,hist,nd,ned,ois,wqs"
+            - name: PKG-TEST
+              run: |
+                  python -m unittest discover tests/
+            - run: mkdocs build
+            - name: Deploy to Netlify
+              uses: nwtgck/[email protected]
+              with:
+                  publish-dir: "./site"
+                  production-branch: master
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+                  deploy-message: "Deploy from GitHub Actions"
+                  enable-pull-request-comment: true
+                  enable-commit-comment: false
+                  overwrites-pull-request-comment: true
+              env:
+                  NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+                  NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+              timeout-minutes: 10

README.md

@@ -19,6 +19,10 @@ The **segment-geospatial** package draws its inspiration from [segment-anything-
 -   Segment GeoTIFF files using the Segment Anything Model (SAM)
 -   Save segmentation results as common vector formats (GeoPackage, Shapefile, GeoJSON, etc.)
 
+## Examples
+
+- [Segmenting satellite imagery](https://samgeo.gishub.org/examples/satellite)
+
 ## Acknowledgements
 
 This package was made possible by the following open source projects. Credit goes to the developers of these projects.

docs/index.md

@@ -19,6 +19,10 @@ The **segment-geospatial** package draws its inspiration from [segment-anything-
 -   Segment GeoTIFF files using the Segment Anything Model (SAM)
 -   Save segmentation results as common vector formats (GeoPackage, Shapefile, GeoJSON, etc.)
 
+## Examples
+
+- [Segmenting satellite imagery](https://samgeo.gishub.org/examples/satellite)
+
 ## Acknowledgements
 
 This package was made possible by the following open source projects. Credit goes to the developers of these projects.

requirements_docs.txt

@@ -0,0 +1,28 @@
+black
+black[jupyter]
+codespell
+deadlink
+bump2version
+coverage
+flake8
+ipykernel
+livereload
+nbconvert
+nbformat
+pip
+sphinx
+tox
+twine
+watchdog
+wheel
+mkdocs
+mkdocs-git-revision-date-plugin 
+mkdocs-git-revision-date-localized-plugin
+mkdocs-jupyter>=0.24.0
+mkdocs-material>=9.1.3 
+mkdocs-pdf-export-plugin
+mkdocstrings
+mkdocstrings-crystal
+mkdocstrings-python-legacy
+pygments
+pymdown-extensions