Commit 66d550f
Functions & Classes Docstring Review (#302)
* add pydata theme and structure modules
* install pydata theme instead sphinx_rtd
* update xarray-spatial logo
* update css
* remove unused RST files
* add sphinx_panels and github url
* update index page css, description images, and examples
* add docs requirements
* add sphinx autosummary
* fix example docstrings
* fix formatting for sphinx doc build
* fix example formatting, made all formatting the same and readable for sphinx and hinting
* update data paths
* add example terrain data
* update aspect example using new data
* fix print data
* update bump example with example_terrain data
* add max elevation attribute to example_terrain data
* update aspect example with example_terrain data
* update bump example with example_terrain updated data
* update reclassify example with terrain_example data, fix aspect & bump example formatting
* update quantile example with terrain_example data
* move example_terrain data to docs/source/_static
* update curvature example with terrain_example data
* change docstring return to np.ndarray
* update focal and hillshade examples using example_terrain data
* remove example_terrain data
* update aspect doc, still needs images
* Delete misc.xml
* Delete modules.xml
* Delete vcs.xml
* Delete workspace.xml
* Delete xarray-spatial.iml
* add terrain_example docstring image
* add aspect example docstring image
* remove docstring images
* add pathfinding composite image
* add pathfinding example image
* add allocation composite image
* add allocation cities example image
* add allocation example image
* add aspect composite image
* add aspect example image
* add direction example image
* add equal interval example image
* add hillshade composite image
* add hillshade example image
* add natural breaks example iamge
* add proximity composite image
* add proximity example image
* add quantile example image
* add reclassify example image
* add terrain example image
* add volcano example image
* add aspect images
* add reclassify images
* add quantile images
* add natural breaks images
* add equal interval iamges
* add direction example images
* add allocation example images
* add proximity example images
* add hillshade example image
* add pathfinding example image
* fix hotspots, calc_cellsize, circle_kernel docstring convention
* add mean example image
* fix calc_cellsize sample data
* add hotspots example images
* add apply example image
* add arvi example images
* add evi example images
* add gci example images
* add nbr example images
* add nbr2 example images
* add ndvi example images
* add ndmi example images
* add savi example images
* add sipi example images
* add curvature example images
* add bump example images
* add focal.calc_sum docstring
* add focal.custom_kernel docstring
* add focal.upper_bound_p_value dosctring
* add zonal.get_full_extent docstring
* add perlin example images
* minor formatting fixes
* add viewshed example images
* add terrain example image
* add matplotlib plotting
* remove docstring images
* change images from static to generated
* change static images to generated images
* change to generated image
* add generated images
* minor formatting fixes
* add focal.calc_sum docstring
* add generated images
* hide source code link
* fix classify module docstrings
* fix aspect module docstrings
* fix bump module docstrings
* fix convolution module docstrings
* fix curvature module docstrings
* remove esri module docstrings
* fix focal module docstrings
* fix hillshade module docstrings
* fix multispectral module docstrings
* fix pathfinding module docstrings
* fix perlin module docstrings
* fix proximity module docstrings
* fix slope module docstrings
* fix terrain module docstrings
* fix tiles module docstrings
* fix utils module docstrings
* fix viewshed module docstrings
* fix zonal module docstrings
* remove unused images
* Revert "update data paths"
This reverts commit 3cafa5e.
* Revert "add tests and refactor _add_crs function to keep existing coords; NEED edit of convolve_2dgit add ."
This reverts commit c40ba8a.
* revert commit 69d7d18
* revert commit 30ac820
* revert commit 970a8ec
* solve conflits
* fix code format
* revert dev requirements
* fix sphinx extensions
* update docs requirements and config
* fix code format
* fix focal docstrings
* fix convolution docstrings
* fix convolution and focal modules docstrings
* update focal summary
Co-authored-by: chloe <chlochlo.lexa@gmail.com>
Co-authored-by: giancastro <giancastrok@gmail.com>1 parent a65681c commit 66d550f
File tree
22 files changed
+4511
-2783
lines changed- .github/workflows
- docs/source
- reference
- xrspatial
22 files changed
+4511
-2783
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
| 17 | + | |
27 | 18 | | |
28 | 19 | | |
29 | 20 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| 89 | + | |
89 | 90 | | |
90 | 91 | | |
91 | 92 | | |
| |||
96 | 97 | | |
97 | 98 | | |
98 | 99 | | |
99 | | - | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
100 | 105 | | |
101 | 106 | | |
102 | 107 | | |
| |||
210 | 215 | | |
211 | 216 | | |
212 | 217 | | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
213 | 221 | | |
214 | 222 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
35 | | - | |
| 34 | + | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
| 38 | + | |
39 | 39 | | |
40 | | - | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
| 2 | + | |
| 3 | + | |
2 | 4 | | |
3 | 5 | | |
4 | 6 | | |
| 7 | + | |
5 | 8 | | |
6 | 9 | | |
7 | 10 | | |
8 | | - | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
165 | | - | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
166 | 167 | | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
171 | 172 | | |
172 | 173 | | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
177 | 178 | | |
178 | 179 | | |
179 | | - | |
| 180 | + | |
180 | 181 | | |
181 | | - | |
182 | | - | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | | - | |
190 | | - | |
191 | | - | |
192 | | - | |
193 | | - | |
194 | | - | |
195 | | - | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
203 | | - | |
204 | | - | |
205 | | - | |
206 | | - | |
207 | | - | |
208 | | - | |
209 | | - | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | | - | |
215 | | - | |
216 | | - | |
217 | | - | |
218 | | - | |
219 | | - | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
220 | 270 | | |
221 | | - | |
222 | 271 | | |
223 | 272 | | |
224 | 273 | | |
| |||
0 commit comments