Skip to content

Commit 7e4602f

Browse files
author
Jon Duckworth
authored
Merge pull request #368 from duckontheweb/doc-fixes
Fix spec links and shorten line lengths
2 parents a6ac489 + 984b2e9 commit 7e4602f

File tree

14 files changed

+333
-149
lines changed

14 files changed

+333
-149
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
### Fixed
1515

16+
- Links to STAC Spec point to latest supported version ([#368](https://github.com/stac-utils/pystac/pull/368))
17+
- Links to STAC Extension pages point to repos in `stac-extensions` GitHub org ([#368](https://github.com/stac-utils/pystac/pull/368))
18+
1619
### Removed
1720

1821
## [1.0.0-beta.2]

doc8.ini

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[doc8]
2+
3+
ignore-path=docs/_build,docs/tutorials
4+
max-line-length=88

docs/api.rst

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ API Reference
22
=============
33

44
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.
67

78
pystac
89
------
@@ -13,7 +14,11 @@ pystac
1314
STACObject
1415
----------
1516

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.
1722

1823
.. autoclass:: pystac.STACObject
1924
:members:
@@ -28,7 +33,7 @@ STACObject is the base class for :class:`Catalog <pystac.Catalog>`, :class:`Coll
2833
Catalog Spec
2934
------------
3035

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>`.
3237

3338
Catalog
3439
~~~~~~~
@@ -50,7 +55,7 @@ CatalogType
5055
Collection Spec
5156
---------------
5257

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>`.
5459

5560
Collection
5661
~~~~~~~~~~
@@ -98,7 +103,7 @@ Summaries
98103
Item Spec
99104
---------
100105

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>`.
102107

103108
Item
104109
~~~~
@@ -154,7 +159,8 @@ IO
154159
STAC_IO
155160
~~~~~~~
156161

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.
158164

159165
.. autoclass:: pystac.stac_io.STAC_IO
160166
:members:
@@ -228,7 +234,7 @@ ExtensionManagementMixin
228234
Electro-Optical Extension
229235
-------------------------
230236

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>`.
232238

233239
Band
234240
~~~~
@@ -272,7 +278,7 @@ SummariesEOExtension
272278
Label Extension
273279
---------------
274280

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>`.
276282

277283
LabelItemExt
278284
~~~~~~~~~~~~
@@ -329,7 +335,7 @@ LabelStatistics
329335
Pointcloud Extension
330336
--------------------
331337

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>`.
333339

334340
PointcloudItemExt
335341
~~~~~~~~~~~~~~~~~
@@ -359,7 +365,7 @@ ProjectionItemExt
359365
Timestamps Extension
360366
--------------------
361367

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>`.
363369

364370
TimestampsItemExt
365371
~~~~~~~~~~~~~~~~~
@@ -374,7 +380,7 @@ TimestampsItemExt
374380
SAR Extension
375381
-------------
376382

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>`.
378384

379385
SarItemExt
380386
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -389,7 +395,7 @@ SarItemExt
389395
SAT Extension
390396
-------------
391397

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>`.
393399

394400
SatItemExt
395401
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -404,7 +410,8 @@ SatItemExt
404410
Single File STAC Extension
405411
--------------------------
406412

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>`.
408415

409416
**TEMPORARILY REMOVED**
410417

@@ -423,15 +430,15 @@ SingleFileSTACCatalogExt
423430
Version Extension
424431
-----------------
425432

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>`.
427434

428435
VersionRelType
429436
~~~~~~~~~~~~~~
430437

431438
.. autoclass:: pystac.extensions.version.VersionRelType
432439
:members:
433440
:show-inheritance:
434-
441+
435442
VersionCollectionExt
436443
~~~~~~~~~~~~~~~~~~~~
437444

@@ -455,7 +462,7 @@ VersionItemExt
455462
View Geometry Extension
456463
-----------------------
457464

458-
Implements the `View Geometry Extension <https://github.com/radiantearth/stac-spec/tree/v1.0.0-beta.2/extensions/view>`_.
465+
Implements the :stac-ext:`View Geometry Extension <view>`.
459466

460467
ViewItemExt
461468
~~~~~~~~~~~
@@ -529,10 +536,10 @@ STACValidator
529536
SchemaUriMap
530537
~~~~~~~~~~~~
531538

532-
A ``SchemaMapUri`` defines methods for mapping STAC versions, object types and extension ids to
533-
schema URIs. A default implementation is included that uses known locations; however users
534-
can provide their own schema URI maps in a :class:`~pystac.validation.JsonSchemaSTACValidator`
535-
to modify the URIs used.
539+
A ``SchemaMapUri`` defines methods for mapping STAC versions, object types and extension
540+
ids to schema URIs. A default implementation is included that uses known locations;
541+
however users can provide their own schema URI maps in a
542+
:class:`~pystac.validation.JsonSchemaSTACValidator` to modify the URIs used.
536543

537544
.. .. autoclass:: pystac.validation.SchemaUriMap
538545
.. :members:

0 commit comments

Comments
 (0)