Skip to content

Updates for new docs location #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2022
Merged

Updates for new docs location #569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,24 @@ Planet API's ([analytics](https://developers.planet.com/docs/analytics/),

## Documentation

Full documentation is not yet hosted online but can be built and hosted locally
(see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be read from source in the
`[docs](docs/)` directory.
Documentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/)
It should be considered 'in progress', with many updated to come. It can also
be built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be
read from source in the `[docs](docs/)` directory.

## Quick Start

The Planet SDK includes both a Python API and a command-line interface (CLI)
to make use of the following Planet APIs:

* [orders](https://developers.planet.com/docs/orders/)
* [data](https://developers.planet.com/docs/data/) (not yet implemented)
* [data](https://developers.planet.com/docs/data/) (in progress)
* [subscriptions](https://developers.planet.com/docs/subscriptions/) (not
yet implemented)

This quickstart focuses on getting started with the CLI to place an order.
For information on the Python API see the
[documentation](https://planet-sdk-for-python.readthedocs.io/en/latest/)
[documentation]([https://planet-sdk-for-python.readthedocs.io/en/latest/](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/))

After you've installed the client, as explained in the [installation](#installation)
section below, you first must initialize the client with your Planet
Expand Down