Fix up docs linking (#1499)

* Fix up docs linking

* Missed a colon

* Update changelog

Author: jsignell

.github/workflows/continuous-integration.yml

@@ -161,4 +161,4 @@ jobs:
       - name: Install pystac
         run: uv sync --no-dev && uv sync --package pystac-docs --inexact
       - name: Check docs
-        run: uv run make -C docs html SPHINXOPTS="-W --keep-going"
+        run: uv run make -C docs html SPHINXOPTS="-W --keep-going -n"

CHANGELOG.md

@@ -21,6 +21,7 @@
 
 - Use `application/geo+json` for `item` links ([#1495](https://github.com/stac-utils/pystac/pull/1495))
 - Includes the scientific extension in Item's ext interface ([#1496](https://github.com/stac-utils/pystac/pull/1496))
+- Fixes all broken documentation links and adds check to CI ([#1499](https://github.com/stac-utils/pystac/pull/1499))
 
 ## [v1.11.0] - 2024-09-26
 

docs/api.rst

@@ -191,9 +191,7 @@ Serialization
 The ``pystac.serialization`` sub-package contains tools used internally by PySTAC to
 identify, serialize, and migrate STAC objects:
 
-* :mod:`pystac.serialization.identify`: Tools for identifying STAC objects
-* :mod:`pystac.serialization.migrate`: Tools for migrating STAC objects from a previous
-  STAC Spec version.
+* :mod:`pystac.serialization`: Tools for identifying and migrating STAC objects
 
 
 Validation

docs/api/asset.rst

@@ -1,7 +1,12 @@
 pystac.asset
 ============
 
-.. automodule:: pystac.asset
+.. autoclass:: pystac.asset.Asset
     :members:
     :undoc-members:
     :noindex:
+
+.. automodule:: pystac.asset
+    :members:
+    :undoc-members:
+    :exclude-members: Asset

docs/api/catalog.rst

@@ -1,7 +1,12 @@
 pystac.catalog
 ==============
 
-.. automodule:: pystac.catalog
+.. autoclass:: pystac.catalog.Catalog
     :members:
     :undoc-members:
     :noindex:
+
+.. automodule:: pystac.catalog
+    :members:
+    :undoc-members:
+    :exclude-members: Catalog

docs/api/collection.rst

@@ -1,7 +1,12 @@
 pystac.collection
 =================
 
-.. automodule:: pystac.collection
+.. autoclass:: pystac.collection.Collection
     :members:
     :undoc-members:
     :noindex:
+
+.. automodule:: pystac.collection
+    :members:
+    :undoc-members:
+    :exclude-members: Collection

docs/api/extensions.rst

@@ -13,8 +13,8 @@ pystac.extensions
 
 .. autosummary::
 
-    datacube.DatacubeExtension
     classification.ClassificationExtension
+    datacube.DatacubeExtension
     eo.EOExtension
     file.FileExtension
     grid.GridExtension
@@ -23,6 +23,7 @@ pystac.extensions
     pointcloud.PointcloudExtension
     projection.ProjectionExtension
     raster.RasterExtension
+    render.RenderExtension
     sar.SarExtension
     sat.SatExtension
     scientific.ScientificExtension

docs/api/extensions/ext.rst

@@ -0,0 +1,7 @@
+pytac.extensions.ext
+====================
+
+.. automodule:: pystac.extensions.ext
+   :members:
+   :inherited-members:
+   :undoc-members:

docs/api/extensions/render.rst

@@ -0,0 +1,6 @@
+pystac.extensions.render
+========================
+
+.. automodule:: pystac.extensions.render
+   :members:
+   :undoc-members:

docs/api/item.rst

@@ -1,7 +1,12 @@
 pystac.item
 ===========
 
-.. automodule:: pystac.item
+.. autoclass:: pystac.item.Item
     :members:
     :undoc-members:
     :noindex:
+
+.. automodule:: pystac.item
+    :members:
+    :undoc-members:
+    :exclude-members: Item