Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/api/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion docs/api/extensions/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pytac.extensions.base
.. automodule:: pystac.extensions.base
:members:
:undoc-members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/api/extensions/classification.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytac.extensions.classification
===============================

.. automodule:: pystac.extensions.classification
:members:
:undoc-members:
4 changes: 3 additions & 1 deletion docs/api/extensions/datacube.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ pystac.extensions.datacube
.. automodule:: pystac.extensions.datacube
:members:
:undoc-members:
:show-inheritance:

.. autoautosummary::
:methods:
1 change: 0 additions & 1 deletion docs/api/extensions/eo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.eo
.. automodule:: pystac.extensions.eo
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.file
.. automodule:: pystac.extensions.file
:members:
:undoc-members:
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/api/extensions/grid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytac.extensions.grid
=====================

.. automodule:: pystac.extensions.grid
:members:
:undoc-members:
1 change: 0 additions & 1 deletion docs/api/extensions/hooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.hooks
.. automodule:: pystac.extensions.hooks
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/item_assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.item\_assets
.. automodule:: pystac.extensions.item_assets
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/label.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.label
.. automodule:: pystac.extensions.label
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/mgrs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.mgrs
.. automodule:: pystac.extensions.mgrs
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/pointcloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.pointcloud
.. automodule:: pystac.extensions.pointcloud
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/projection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.projection
.. automodule:: pystac.extensions.projection
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/raster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.raster
.. automodule:: pystac.extensions.raster
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/sar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.sar
.. automodule:: pystac.extensions.sar
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/sat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.sat
.. automodule:: pystac.extensions.sat
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/scientific.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.scientific
.. automodule:: pystac.extensions.scientific
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.storage
.. automodule:: pystac.extensions.storage
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.table
.. automodule:: pystac.extensions.table
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/timestamps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.timestamps
.. automodule:: pystac.extensions.timestamps
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.version
.. automodule:: pystac.extensions.version
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/extensions/view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.extensions.view
.. automodule:: pystac.extensions.view
:members:
:undoc-members:
:show-inheritance:
27 changes: 22 additions & 5 deletions docs/api/pystac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------

Expand All @@ -22,7 +44,6 @@ Catalog
.. autoclass:: pystac.Catalog
:members:
:undoc-members:
:show-inheritance:

CatalogType
-----------
Expand All @@ -38,7 +59,6 @@ Collection
.. autoclass:: pystac.Collection
:members:
:undoc-members:
:show-inheritance:

Extent
------
Expand Down Expand Up @@ -67,7 +87,6 @@ ProviderRole
.. autoclass:: pystac.ProviderRole
:members:
:undoc-members:
:show-inheritance:

Provider
--------
Expand All @@ -89,7 +108,6 @@ Item
.. autoclass:: pystac.Item
:members:
:undoc-members:
:show-inheritance:

Asset
-----
Expand All @@ -110,7 +128,6 @@ ItemCollection

.. autoclass:: pystac.ItemCollection
:members:
:show-inheritance:

Link
----
Expand Down
1 change: 0 additions & 1 deletion docs/api/serialization/common_properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.serialization.common\_properties
.. automodule:: pystac.serialization.common_properties
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/serialization/identify.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ pystac.serialization.identify
.. automodule:: pystac.serialization.identify
:members:
:undoc-members:
:show-inheritance:

:noindex:
1 change: 0 additions & 1 deletion docs/api/serialization/migrate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.serialization.migrate
.. automodule:: pystac.serialization.migrate
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/validation/schema_uri_map.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.validation.schema\_uri\_map
.. automodule:: pystac.validation.schema_uri_map
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/api/validation/stac_validator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ pystac.validation.stac\_validator
.. automodule:: pystac.validation.stac_validator
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
extensions = [
"sphinx_design",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
Expand Down