Skip to content

Commit 2688e56

Browse files
brendancolbrendancol
authored
Add missing API reference docs for ~30 undocumented functions (#941) (#942)
New .rst files for hydrology, terrain metrics, interpolation, and utilities. Updated classification, proximity, and surface pages with functions that were exported but had no doc entries. Added all new pages to the reference toctree.
1 parent 4211830 commit 2688e56

File tree

8 files changed

+263
-0
lines changed

8 files changed

+263
-0
lines changed

‎docs/source/reference/classification.rst‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,45 @@ Quantile
3131
:toctree: _autosummary
3232

3333
xrspatial.classify.quantile
34+
35+
Binary
36+
======
37+
.. autosummary::
38+
:toctree: _autosummary
39+
40+
xrspatial.classify.binary
41+
42+
Box Plot
43+
========
44+
.. autosummary::
45+
:toctree: _autosummary
46+
47+
xrspatial.classify.box_plot
48+
49+
Head/Tail Breaks
50+
================
51+
.. autosummary::
52+
:toctree: _autosummary
53+
54+
xrspatial.classify.head_tail_breaks
55+
56+
Maximum Breaks
57+
==============
58+
.. autosummary::
59+
:toctree: _autosummary
60+
61+
xrspatial.classify.maximum_breaks
62+
63+
Percentiles
64+
===========
65+
.. autosummary::
66+
:toctree: _autosummary
67+
68+
xrspatial.classify.percentiles
69+
70+
Standard Mean
71+
=============
72+
.. autosummary::
73+
:toctree: _autosummary
74+
75+
xrspatial.classify.std_mean

‎docs/source/reference/hydrology.rst‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
.. _reference.hydrology:
2+
3+
*********
4+
Hydrology
5+
*********
6+
7+
Flow Direction
8+
==============
9+
.. autosummary::
10+
:toctree: _autosummary
11+
12+
xrspatial.flow_direction.flow_direction
13+
14+
Flow Direction (D-infinity)
15+
===========================
16+
.. autosummary::
17+
:toctree: _autosummary
18+
19+
xrspatial.flow_direction_dinf.flow_direction_dinf
20+
21+
Flow Accumulation
22+
=================
23+
.. autosummary::
24+
:toctree: _autosummary
25+
26+
xrspatial.flow_accumulation.flow_accumulation
27+
28+
Flow Length
29+
===========
30+
.. autosummary::
31+
:toctree: _autosummary
32+
33+
xrspatial.flow_length.flow_length
34+
35+
Flow Path
36+
=========
37+
.. autosummary::
38+
:toctree: _autosummary
39+
40+
xrspatial.flow_path.flow_path
41+
42+
Fill
43+
====
44+
.. autosummary::
45+
:toctree: _autosummary
46+
47+
xrspatial.fill.fill
48+
49+
Sink
50+
====
51+
.. autosummary::
52+
:toctree: _autosummary
53+
54+
xrspatial.sink.sink
55+
56+
Basin
57+
=====
58+
.. autosummary::
59+
:toctree: _autosummary
60+
61+
xrspatial.basin.basin
62+
63+
Watershed
64+
=========
65+
.. autosummary::
66+
:toctree: _autosummary
67+
68+
xrspatial.watershed.watershed
69+
xrspatial.watershed.basins
70+
71+
Snap Pour Point
72+
===============
73+
.. autosummary::
74+
:toctree: _autosummary
75+
76+
xrspatial.snap_pour_point.snap_pour_point
77+
78+
Stream Link
79+
===========
80+
.. autosummary::
81+
:toctree: _autosummary
82+
83+
xrspatial.stream_link.stream_link
84+
85+
Stream Order
86+
============
87+
.. autosummary::
88+
:toctree: _autosummary
89+
90+
xrspatial.stream_order.stream_order
91+
92+
Height Above Nearest Drainage (HAND)
93+
=====================================
94+
.. autosummary::
95+
:toctree: _autosummary
96+
97+
xrspatial.hand.hand
98+
99+
Topographic Wetness Index (TWI)
100+
===============================
101+
.. autosummary::
102+
:toctree: _autosummary
103+
104+
xrspatial.twi.twi

‎docs/source/reference/index.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ Reference
1212
fire
1313
flood
1414
focal
15+
hydrology
16+
interpolation
1517
multispectral
1618
pathfinding
1719
proximity
1820
surface
21+
terrain_metrics
22+
utilities
1923
zonal

‎docs/source/reference/interpolation.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _reference.interpolation:
2+
3+
*************
4+
Interpolation
5+
*************
6+
7+
Inverse Distance Weighting (IDW)
8+
=================================
9+
.. autosummary::
10+
:toctree: _autosummary
11+
12+
xrspatial.interpolate.idw
13+
14+
Kriging
15+
=======
16+
.. autosummary::
17+
:toctree: _autosummary
18+
19+
xrspatial.interpolate.kriging
20+
21+
Spline
22+
======
23+
.. autosummary::
24+
:toctree: _autosummary
25+
26+
xrspatial.interpolate.spline

‎docs/source/reference/proximity.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,24 @@ Cost Distance
3434
:toctree: _autosummary
3535

3636
xrspatial.cost_distance.cost_distance
37+
38+
Surface Distance
39+
================
40+
.. autosummary::
41+
:toctree: _autosummary
42+
43+
xrspatial.surface_distance.surface_distance
44+
45+
Surface Allocation
46+
==================
47+
.. autosummary::
48+
:toctree: _autosummary
49+
50+
xrspatial.surface_distance.surface_allocation
51+
52+
Surface Direction
53+
=================
54+
.. autosummary::
55+
:toctree: _autosummary
56+
57+
xrspatial.surface_distance.surface_direction

‎docs/source/reference/surface.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,10 @@ Bump Mapping
5959
:toctree: _autosummary
6060

6161
xrspatial.bump.bump
62+
63+
Erosion
64+
=======
65+
.. autosummary::
66+
:toctree: _autosummary
67+
68+
xrspatial.erosion.erode

‎docs/source/reference/terrain_metrics.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _reference.terrain_metrics:
2+
3+
***************
4+
Terrain Metrics
5+
***************
6+
7+
Roughness
8+
=========
9+
.. autosummary::
10+
:toctree: _autosummary
11+
12+
xrspatial.terrain_metrics.roughness
13+
14+
Topographic Position Index (TPI)
15+
================================
16+
.. autosummary::
17+
:toctree: _autosummary
18+
19+
xrspatial.terrain_metrics.tpi
20+
21+
Terrain Ruggedness Index (TRI)
22+
==============================
23+
.. autosummary::
24+
:toctree: _autosummary
25+
26+
xrspatial.terrain_metrics.tri

‎docs/source/reference/utilities.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _reference.utilities:
2+
3+
*********
4+
Utilities
5+
*********
6+
7+
Mahalanobis Distance
8+
====================
9+
.. autosummary::
10+
:toctree: _autosummary
11+
12+
xrspatial.mahalanobis.mahalanobis
13+
14+
Emerging Hotspots
15+
=================
16+
.. autosummary::
17+
:toctree: _autosummary
18+
19+
xrspatial.emerging_hotspots.emerging_hotspots
20+
21+
Polygonize
22+
==========
23+
.. autosummary::
24+
:toctree: _autosummary
25+
26+
xrspatial.polygonize.polygonize
27+
28+
Diagnostics
29+
===========
30+
.. autosummary::
31+
:toctree: _autosummary
32+
33+
xrspatial.diagnostics.diagnose

0 commit comments

Comments
 (0)