diff --git a/docs/api/extensions.rst b/docs/api/extensions.rst index 14d4ec2e9..a45a709f8 100644 --- a/docs/api/extensions.rst +++ b/docs/api/extensions.rst @@ -7,3 +7,28 @@ pystac.extensions :glob: extensions/* + + +.. currentmodule:: pystac.extensions + +.. autosummary:: + + datacube.DatacubeExtension + classification.ClassificationExtension + eo.EOExtension + file.FileExtension + grid.GridExtension + item_assets.ItemAssetsExtension + label.LabelExtension + mgrs.MgrsExtension + pointcloud.PointcloudExtension + projection.ProjectionExtension + raster.RasterExtension + sar.SarExtension + sat.SatExtension + scientific.ScientificExtension + storage.StorageExtension + table.TableExtension + timestamps.TimestampsExtension + version.VersionExtension + view.ViewExtension diff --git a/docs/api/extensions/base.rst b/docs/api/extensions/base.rst index 513ab5893..2085f3f94 100644 --- a/docs/api/extensions/base.rst +++ b/docs/api/extensions/base.rst @@ -4,4 +4,3 @@ pytac.extensions.base .. automodule:: pystac.extensions.base :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/classification.rst b/docs/api/extensions/classification.rst new file mode 100644 index 000000000..5b6e79aec --- /dev/null +++ b/docs/api/extensions/classification.rst @@ -0,0 +1,6 @@ +pytac.extensions.classification +=============================== + +.. automodule:: pystac.extensions.classification + :members: + :undoc-members: diff --git a/docs/api/extensions/datacube.rst b/docs/api/extensions/datacube.rst index 97564ddb5..6d8f50c20 100644 --- a/docs/api/extensions/datacube.rst +++ b/docs/api/extensions/datacube.rst @@ -4,4 +4,6 @@ pystac.extensions.datacube .. automodule:: pystac.extensions.datacube :members: :undoc-members: - :show-inheritance: + + .. autoautosummary:: + :methods: diff --git a/docs/api/extensions/eo.rst b/docs/api/extensions/eo.rst index 829272559..c46515d09 100644 --- a/docs/api/extensions/eo.rst +++ b/docs/api/extensions/eo.rst @@ -4,4 +4,3 @@ pystac.extensions.eo .. automodule:: pystac.extensions.eo :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/file.rst b/docs/api/extensions/file.rst index 1d34d94b6..2e33794e1 100644 --- a/docs/api/extensions/file.rst +++ b/docs/api/extensions/file.rst @@ -4,4 +4,3 @@ pystac.extensions.file .. automodule:: pystac.extensions.file :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/grid.rst b/docs/api/extensions/grid.rst new file mode 100644 index 000000000..b8f31ca6e --- /dev/null +++ b/docs/api/extensions/grid.rst @@ -0,0 +1,6 @@ +pytac.extensions.grid +===================== + +.. automodule:: pystac.extensions.grid + :members: + :undoc-members: diff --git a/docs/api/extensions/hooks.rst b/docs/api/extensions/hooks.rst index 6e02d08d3..949847bb4 100644 --- a/docs/api/extensions/hooks.rst +++ b/docs/api/extensions/hooks.rst @@ -4,4 +4,3 @@ pystac.extensions.hooks .. automodule:: pystac.extensions.hooks :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/item_assets.rst b/docs/api/extensions/item_assets.rst index e6003f3e4..c46ce768d 100644 --- a/docs/api/extensions/item_assets.rst +++ b/docs/api/extensions/item_assets.rst @@ -4,4 +4,3 @@ pystac.extensions.item\_assets .. automodule:: pystac.extensions.item_assets :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/label.rst b/docs/api/extensions/label.rst index 780abbf59..55f66592f 100644 --- a/docs/api/extensions/label.rst +++ b/docs/api/extensions/label.rst @@ -4,4 +4,3 @@ pystac.extensions.label .. automodule:: pystac.extensions.label :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/mgrs.rst b/docs/api/extensions/mgrs.rst index 880f8525d..5bcb6b389 100644 --- a/docs/api/extensions/mgrs.rst +++ b/docs/api/extensions/mgrs.rst @@ -4,4 +4,3 @@ pystac.extensions.mgrs .. automodule:: pystac.extensions.mgrs :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/pointcloud.rst b/docs/api/extensions/pointcloud.rst index 749bfe482..24dde5031 100644 --- a/docs/api/extensions/pointcloud.rst +++ b/docs/api/extensions/pointcloud.rst @@ -4,4 +4,3 @@ pystac.extensions.pointcloud .. automodule:: pystac.extensions.pointcloud :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/projection.rst b/docs/api/extensions/projection.rst index 6f7db1449..65f079f8d 100644 --- a/docs/api/extensions/projection.rst +++ b/docs/api/extensions/projection.rst @@ -4,4 +4,3 @@ pystac.extensions.projection .. automodule:: pystac.extensions.projection :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/raster.rst b/docs/api/extensions/raster.rst index a43ed37a9..7f67d824d 100644 --- a/docs/api/extensions/raster.rst +++ b/docs/api/extensions/raster.rst @@ -4,4 +4,3 @@ pystac.extensions.raster .. automodule:: pystac.extensions.raster :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/sar.rst b/docs/api/extensions/sar.rst index 86da53983..9f48cc5c8 100644 --- a/docs/api/extensions/sar.rst +++ b/docs/api/extensions/sar.rst @@ -4,4 +4,3 @@ pystac.extensions.sar .. automodule:: pystac.extensions.sar :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/sat.rst b/docs/api/extensions/sat.rst index e1c14807a..793a47862 100644 --- a/docs/api/extensions/sat.rst +++ b/docs/api/extensions/sat.rst @@ -4,4 +4,3 @@ pystac.extensions.sat .. automodule:: pystac.extensions.sat :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/scientific.rst b/docs/api/extensions/scientific.rst index e3ee15a74..83d06361e 100644 --- a/docs/api/extensions/scientific.rst +++ b/docs/api/extensions/scientific.rst @@ -4,4 +4,3 @@ pystac.extensions.scientific .. automodule:: pystac.extensions.scientific :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/storage.rst b/docs/api/extensions/storage.rst index a0286b8f2..420e5dfb1 100644 --- a/docs/api/extensions/storage.rst +++ b/docs/api/extensions/storage.rst @@ -4,4 +4,3 @@ pystac.extensions.storage .. automodule:: pystac.extensions.storage :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/table.rst b/docs/api/extensions/table.rst index b1fe86bfc..80abd7dc1 100644 --- a/docs/api/extensions/table.rst +++ b/docs/api/extensions/table.rst @@ -4,4 +4,3 @@ pystac.extensions.table .. automodule:: pystac.extensions.table :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/timestamps.rst b/docs/api/extensions/timestamps.rst index 6b071b894..da5758255 100644 --- a/docs/api/extensions/timestamps.rst +++ b/docs/api/extensions/timestamps.rst @@ -4,4 +4,3 @@ pystac.extensions.timestamps .. automodule:: pystac.extensions.timestamps :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/version.rst b/docs/api/extensions/version.rst index 08cb7f1bc..4c606ce75 100644 --- a/docs/api/extensions/version.rst +++ b/docs/api/extensions/version.rst @@ -4,4 +4,3 @@ pystac.extensions.version .. automodule:: pystac.extensions.version :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/extensions/view.rst b/docs/api/extensions/view.rst index 42c3d31bb..1b395df28 100644 --- a/docs/api/extensions/view.rst +++ b/docs/api/extensions/view.rst @@ -4,4 +4,3 @@ pystac.extensions.view .. automodule:: pystac.extensions.view :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/pystac.rst b/docs/api/pystac.rst index 40b5fb9a6..8c6da7abd 100644 --- a/docs/api/pystac.rst +++ b/docs/api/pystac.rst @@ -4,6 +4,28 @@ pystac .. automodule:: pystac :members: read_file, write_file, read_dict, set_stac_version, get_stac_version + .. autosummary:: + STACObject + Catalog + Collection + Extent + SpatialExtent + TemporalExtent + Provider + Summaries + Item + Asset + CommonMetadata + ItemCollection + Link + StacIO + read_file + write_file + read_dict + set_stac_version + get_stac_version + + STACObject ---------- @@ -22,7 +44,6 @@ Catalog .. autoclass:: pystac.Catalog :members: :undoc-members: - :show-inheritance: CatalogType ----------- @@ -38,7 +59,6 @@ Collection .. autoclass:: pystac.Collection :members: :undoc-members: - :show-inheritance: Extent ------ @@ -67,7 +87,6 @@ ProviderRole .. autoclass:: pystac.ProviderRole :members: :undoc-members: - :show-inheritance: Provider -------- @@ -89,7 +108,6 @@ Item .. autoclass:: pystac.Item :members: :undoc-members: - :show-inheritance: Asset ----- @@ -110,7 +128,6 @@ ItemCollection .. autoclass:: pystac.ItemCollection :members: - :show-inheritance: Link ---- diff --git a/docs/api/serialization/common_properties.rst b/docs/api/serialization/common_properties.rst index 0ed7fb557..5666ca965 100644 --- a/docs/api/serialization/common_properties.rst +++ b/docs/api/serialization/common_properties.rst @@ -4,4 +4,3 @@ pystac.serialization.common\_properties .. automodule:: pystac.serialization.common_properties :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/serialization/identify.rst b/docs/api/serialization/identify.rst index 97451bf51..6a1047cd1 100644 --- a/docs/api/serialization/identify.rst +++ b/docs/api/serialization/identify.rst @@ -4,5 +4,5 @@ pystac.serialization.identify .. automodule:: pystac.serialization.identify :members: :undoc-members: - :show-inheritance: + :noindex: diff --git a/docs/api/serialization/migrate.rst b/docs/api/serialization/migrate.rst index 272a24dfe..df03f05ec 100644 --- a/docs/api/serialization/migrate.rst +++ b/docs/api/serialization/migrate.rst @@ -4,4 +4,3 @@ pystac.serialization.migrate .. automodule:: pystac.serialization.migrate :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/validation/schema_uri_map.rst b/docs/api/validation/schema_uri_map.rst index 83ceece89..231bd2f28 100644 --- a/docs/api/validation/schema_uri_map.rst +++ b/docs/api/validation/schema_uri_map.rst @@ -4,4 +4,3 @@ pystac.validation.schema\_uri\_map .. automodule:: pystac.validation.schema_uri_map :members: :undoc-members: - :show-inheritance: diff --git a/docs/api/validation/stac_validator.rst b/docs/api/validation/stac_validator.rst index d8aef85ba..84b53abab 100644 --- a/docs/api/validation/stac_validator.rst +++ b/docs/api/validation/stac_validator.rst @@ -4,4 +4,3 @@ pystac.validation.stac\_validator .. automodule:: pystac.validation.stac_validator :members: :undoc-members: - :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 0bc7a88a9..798be2dd0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,6 +51,7 @@ extensions = [ "sphinx_design", "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.viewcode", "sphinx.ext.intersphinx", "sphinx.ext.napoleon",