Skip to content

Commit e3e87f6

Browse files
committed
Add to user guide
1 parent 1cceacb commit e3e87f6

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

docs/index.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,17 @@ Sasquatchbackpack is a collection of APIs that feed into `sasquatch <https://sas
99
Data from integrated APIs is automatically streamed to sasquatch via cron-job via `Phalanx <https://phalanx.lsst.io/>`__ deployment.
1010
Backpack also features CLI entrypoints for easy local access to integrated APIs (See the `CLI Page <user-guide/cli.html>`__ for details).
1111

12+
The current APIs that run off of Sasquatch-backpack are:
13+
14+
- `USGS Earthquake data <https://code.usgs.gov/ghsc/esi/libcomcat-python>`__
15+
1216
Install Sasquatch-backpack from PyPI:
1317

1418
.. code-block:: bash
1519
1620
pip install sasquatchbackpack
1721
18-
.. role:: red
19-
.. role:: green
20-
21-
**Please note that all CLI interaction with Sasquatch-backpack is done sans hyphen!** (:green:`"sasquatchbackpack"`, not :red:`"sasquatch-backpack"`)
22-
23-
The current APIs that run off of Sasquatch-backpack are:
24-
25-
- USGS Earthquake data (`libcomcat <https://code.usgs.gov/ghsc/esi/libcomcat-python>`__)
22+
**All CLI interaction with Sasquatch-backpack is done sans hyphen. ("sasquatchbackpack", not "sasquatch-backpack"`)**
2623

2724
Sasquatch-backpack is developed on GitHub at https://github.com/lsst-sqre/sasquatch-backpack.
2825

docs/user-guide/cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Command-line interface
33

44
The commands for the :command:`sasquatch-backpack` CLI are documented here.
55

6-
You can get detailed help for any :command:`sasquatch-backpack` command by running :command:`sasquatch-backpack --help`
6+
You can get detailed help for any :command:`sasquatchbackpack` command by running :command:`sasquatchbackpack --help`
77

88
.. click:: sasquatchbackpack.cli:main
99
:prog: sasquatchbackpack

docs/user-guide/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
User guide
55
##########
66

7+
Sasquatch-backpack can be installed directly from PyPI and run as a command-line tool, but it is normally run via various `Phalanx <https://phalanx.lsst.io/>`__ cron-jobs.
8+
79
.. toctree::
8-
:maxdepth: 2
10+
:caption: Reference
911

10-
CLI <cli>
12+
cli

0 commit comments

Comments
 (0)