Skip to content

Commit

Permalink
Merge pull request #93 from gadomski/fix/docs
Browse files Browse the repository at this point in the history
Documentation fixes
  • Loading branch information
gadomski authored Apr 29, 2021
2 parents 33784e1 + 3f1dbea commit 299968a
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ python:
- method: pip
path: stactools_browse/
- method: pip
path: stactools_sentinel/
path: stactools_sentinel2/
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ Table of Contents

api
cli
tutorials
tutorials
7 changes: 7 additions & 0 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,10 @@ Working with Planet data
- :ref:`CLI version </tutorials/working-with-planet-data-in-the-cli.rst>`

This tutorial shows how to convert Planet data obtained via the Orders API into STACs.

.. toctree::
:maxdepth: 2
:hidden:

tutorials/working-with-planet-data-in-python
tutorials/working-with-planet-data-in-the-cli
4 changes: 2 additions & 2 deletions docs/tutorials/working-with-planet-data-in-the-cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Working with Planet Data in the CLI
In this tutorial, we'll use the stactools CLI to work with Planet data. We'll convert two Planet orders into STACs,
merge the STACs, modify their layout, and browse results using the ``stac browse`` command.

If you'd like to use the Python library functionality, see the :ref:`tutorial notebook </tutorials/working-withplanet-data.ipynb>` that performs the same actions, but in Python.
If you'd like to use the Python library functionality, see the :ref:`tutorial notebook </tutorials/working-with-planet-data-in-python.ipynb>` that performs the same actions, but in Python.

You'll need the `stactools_planet` and `stactools_browse` packages to follow along. You can install these with:

Expand All @@ -29,7 +29,7 @@ You'll also need Docker installed to be able to use the ``stac browse`` command.
Ordering from Planet
====================

We'll use IDs that are generated from a search that we performed in the :ref:`tutorial notebook </tutorials/working-withplanet-data.ipynb>`, so see that for a reference of how those searches were performed. The IDs are for 8 items over a part of southern Myanmar. Let's store those IDs in environment variables:
We'll use IDs that are generated from a search that we performed in the :ref:`tutorial notebook </tutorials/working-with-planet-data-in-python.ipynb>`, so see that for a reference of how those searches were performed. The IDs are for 8 items over a part of southern Myanmar. Let's store those IDs in environment variables:

.. code-block:: console
Expand Down
3 changes: 1 addition & 2 deletions stactools_cli/stactools/cli/commands/merge.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ def create_merge_command(cli):
@cli.command('merge', short_help='Merge items from one STAC into another.')
@click.argument('source_catalog')
@click.argument('target_catalog')
@click.option('-c',
'--collection',
@click.option('--collection',
help=("The collection ID to merge into. If not set, will "
"merge into the root catalog or collection."))
@click.option('-a',
Expand Down

0 comments on commit 299968a

Please sign in to comment.