From 441ed35c8662453d8f2ddec2c7a14607f08e998c Mon Sep 17 00:00:00 2001 From: Jon Duckworth Date: Fri, 30 Apr 2021 16:35:24 -0400 Subject: [PATCH 1/2] Add doc build requirements --- .readthedocs.yml | 2 +- requirements-docs.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 requirements-docs.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index b28d047d..14882863 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -21,4 +21,4 @@ python: install: - method: pip path: . - - requirements: requirements_docs.txt \ No newline at end of file + - requirements: requirements-docs.txt \ No newline at end of file diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 00000000..110f4ff7 --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1 @@ +recommonmark~=0.7.1 \ No newline at end of file From 596085f653083083b4feac1215dd1d418be88b3f Mon Sep 17 00:00:00 2001 From: Jon Duckworth Date: Fri, 30 Apr 2021 16:54:21 -0400 Subject: [PATCH 2/2] Update CHANGELOG and README --- CHANGELOG.md | 1 + README.md | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fef020e9..f93bc7f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added - `ItemSearch.items_as_collection` [#37](https://github.com/stac-utils/pystac-client/pull/37) +- Documentation [published on ReadTheDocs](https://pystac-client.readthedocs.io/en/latest/) [#46](https://github.com/stac-utils/pystac-client/pull/46) ### Fixed diff --git a/README.md b/README.md index 62d4e534..db9feedc 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ STAC API Client [![CI](https://github.com/stac-utils/pystac-client/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/stac-utils/pystac-client/actions/workflows/continuous-integration.yml) [![Release](https://github.com/stac-utils/pystac-client/actions/workflows/release.yml/badge.svg)](https://github.com/stac-utils/pystac-client/actions/workflows/release.yml) [![PyPI version](https://badge.fury.io/py/pystac-client.svg)](https://badge.fury.io/py/pystac-client) -[![Documentation](https://readthedocs.org/projects/pystac_client/badge/?version=latest)](https://pystac_client.readthedocs.io/en/latest/) +[![Documentation](https://readthedocs.org/projects/pystac-client/badge/?version=latest)](https://pystac-client.readthedocs.io/en/latest/) [![codecov](https://codecov.io/gh/stac-utils/pystac-client/branch/main/graph/badge.svg)](https://codecov.io/gh/stac-utils/pystac-client) + A Python client for working with [STAC](https://stacspec.org/) Catalogs and APIs. ## Installation @@ -17,6 +18,10 @@ Install from PyPi. Other than PySTAC itself, the only dependency for pystac-clie pip install pystac-client ``` +## Documentation + +See the [documentation page](https://pystac-client.readthedocs.io/en/latest/) for the latest docs. + ## Usage pystac-client can be used as either a CLI or a Python library.