You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.rst
+27-20Lines changed: 27 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@ API Reference
2
2
=============
3
3
4
4
This API reference is auto-generated for the Python docstrings,
5
-
and organized by the section of the `STAC Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2>`_ they relate to, if related to a specific spec item.
5
+
and organized by the section of the :stac-spec:`STAC Spec <>` they relate to, if related
6
+
to a specific spec item.
6
7
7
8
pystac
8
9
------
@@ -13,7 +14,11 @@ pystac
13
14
STACObject
14
15
----------
15
16
16
-
STACObject is the base class for :class:`Catalog <pystac.Catalog>`, :class:`Collection <pystac.Collection>` and :class:`Item <pystac.Item>`, and contains a variety of useful methods for dealing with links, copying objects, accessing extensions, and reading and writing files. You shouldn't use STACObject directly, but instead access this functionality through the implementing classes.
17
+
STACObject is the base class for :class:`Catalog <pystac.Catalog>`, :class:`Collection
18
+
<pystac.Collection>` and :class:`Item <pystac.Item>`, and contains a variety of useful
19
+
methods for dealing with links, copying objects, accessing extensions, and reading and
20
+
writing files. You shouldn't use STACObject directly, but instead access this
21
+
functionality through the implementing classes.
17
22
18
23
.. autoclass:: pystac.STACObject
19
24
:members:
@@ -28,7 +33,7 @@ STACObject is the base class for :class:`Catalog <pystac.Catalog>`, :class:`Coll
28
33
Catalog Spec
29
34
------------
30
35
31
-
These classes are representations of the `Catalog Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/catalog-spec>`_.
36
+
These classes are representations of the :stac-spec:`Catalog Spec <catalog-spec>`.
32
37
33
38
Catalog
34
39
~~~~~~~
@@ -50,7 +55,7 @@ CatalogType
50
55
Collection Spec
51
56
---------------
52
57
53
-
These classes are representations of the `Collection Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/collection-spec>`_.
58
+
These classes are representations of the :stac-spec:`Collection Spec <collection-spec>`.
54
59
55
60
Collection
56
61
~~~~~~~~~~
@@ -98,7 +103,7 @@ Summaries
98
103
Item Spec
99
104
---------
100
105
101
-
These classes are representations of the `Item Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/item-spec>`_.
106
+
These classes are representations of the :stac-spec:`Item Spec <item-spec>`.
102
107
103
108
Item
104
109
~~~~
@@ -154,7 +159,8 @@ IO
154
159
STAC_IO
155
160
~~~~~~~
156
161
157
-
STAC_IO is the utility mechanism that PySTAC uses for reading and writing. Users of PySTAC can hook into PySTAC by overriding members to utilize their own IO methods.
162
+
STAC_IO is the utility mechanism that PySTAC uses for reading and writing. Users of
163
+
PySTAC can hook into PySTAC by overriding members to utilize their own IO methods.
158
164
159
165
.. autoclass:: pystac.stac_io.STAC_IO
160
166
:members:
@@ -228,7 +234,7 @@ ExtensionManagementMixin
228
234
Electro-Optical Extension
229
235
-------------------------
230
236
231
-
These classes are representations of the `EO Extension Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/eo>`_.
237
+
These classes are representations of the :stac-ext:`EO Extension Spec <eo>`.
232
238
233
239
Band
234
240
~~~~
@@ -272,7 +278,7 @@ SummariesEOExtension
272
278
Label Extension
273
279
---------------
274
280
275
-
These classes are representations of the `Label Extension Spec <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/label>`_.
281
+
These classes are representations of the :stac-ext:`Label Extension Spec <label>`.
276
282
277
283
LabelItemExt
278
284
~~~~~~~~~~~~
@@ -329,7 +335,7 @@ LabelStatistics
329
335
Pointcloud Extension
330
336
--------------------
331
337
332
-
Implements the `Point Cloud Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/pointcloud>`_.
338
+
Implements the :stac-ext:`Point Cloud Extension <pointcloud>`.
333
339
334
340
PointcloudItemExt
335
341
~~~~~~~~~~~~~~~~~
@@ -359,7 +365,7 @@ ProjectionItemExt
359
365
Timestamps Extension
360
366
--------------------
361
367
362
-
Implements the `Timestamps Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/timestamps>`_.
368
+
Implements the :stac-ext:`Timestamps Extension <timestamps>`.
363
369
364
370
TimestampsItemExt
365
371
~~~~~~~~~~~~~~~~~
@@ -374,7 +380,7 @@ TimestampsItemExt
374
380
SAR Extension
375
381
-------------
376
382
377
-
Implements the `SAR Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/sar>`_.
383
+
Implements the :stac-ext:`SAR Extension <sar>`.
378
384
379
385
SarItemExt
380
386
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -389,7 +395,7 @@ SarItemExt
389
395
SAT Extension
390
396
-------------
391
397
392
-
Implements the `SAT Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/sat>`_.
398
+
Implements the :stac-ext:`SAT Extension <sat>`.
393
399
394
400
SatItemExt
395
401
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -404,7 +410,8 @@ SatItemExt
404
410
Single File STAC Extension
405
411
--------------------------
406
412
407
-
These classes are representations of the `Single File STAC Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/single-file-stac>`_.
413
+
These classes are representations of the :stac-ext:`Single File STAC Extension
414
+
<single-file-stac>`.
408
415
409
416
**TEMPORARILY REMOVED**
410
417
@@ -423,15 +430,15 @@ SingleFileSTACCatalogExt
423
430
Version Extension
424
431
-----------------
425
432
426
-
Implements the `Version Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/version>`_.
433
+
Implements the :stac-ext:`Version Extension <version>`.
0 commit comments