Skip to content

Commit cbc5029

Browse files
Kharude, Sachinsackh
authored andcommitted
Added documentation for optional dependencies
Signed-off-by: Kharude, Sachin <sachin.kharude@here.com>
1 parent 929e809 commit cbc5029

4 files changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ This package can be installed with `pip` or `conda` from various sources:
7575
pip install xyzspaces
7676
```
7777

78+
- Install from the [Python Package Index](https://pypi.org/project/xyzspaces/) with optional dependencies:
79+
80+
```bash
81+
pip install "xyzspaces[geo]"
82+
```
83+
7884
- Install from its source repository on GitHub:
7985

8086
```bash

docs/source/install.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Installation
22
============
33

4-
xyzspaces depends for its spatial functionality on a large geospatial, open
4+
xyzspaces has optional dependencies for its spatial functionality on a large geospatial, open
55
source stack of libraries (`Geopandas`_, `turfpy`_). See the
66
:ref:`dependencies` section below for more details. The C depedencies of Geopandas such as (`GEOS`_, `GDAL`_, `PROJ`_)
77
can sometimes be a challenge to install. Therefore, we advise you
@@ -52,10 +52,15 @@ xyzspaces in it::
5252
Installing with pip
5353
-------------------
5454

55-
xyzspaces can also be installed with pip::
55+
Install ``xyzspaces`` without optional dependencies::
5656

5757
pip install xyzspaces
5858

59+
Install ``xyzspaces`` with optional dependencies::
60+
61+
pip install "xyzspaces[geo]"
62+
63+
5964
.. _install-deps:
6065

6166
.. warning::
@@ -107,6 +112,11 @@ Required dependencies:
107112

108113
- `requirements`_
109114

115+
Optional depedencies:
116+
117+
- `Geopandas`_
118+
- `turfpy`_
119+
110120
Dev dependencies:
111121

112122
- `dev requirements`_

docs/source/xyzspaces._compact.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
xyzspaces.\_compact module
2+
==========================
3+
4+
.. automodule:: xyzspaces._compact
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
:private-members:

docs/source/xyzspaces.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Submodules
2424
xyzspaces.__version__
2525
xyzspaces.apis
2626
xyzspaces.auth
27+
xyzspaces._compact
2728
xyzspaces.curl
2829
xyzspaces.exceptions
2930
xyzspaces.logconf

0 commit comments

Comments
 (0)