Skip to content

Commit

Permalink
Init Docs
Browse files Browse the repository at this point in the history
update index

More docs edits

edit tagline
  • Loading branch information
Fireye04 committed Feb 1, 2024
1 parent ce2859d commit 96da1a8
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sasquatch-backpack

Collects data and feeds sasquatch.
Sasquatch-backpack is a collection of APIs that feed into sasquatch.
Learn more at https://sasquatch-backpack.lsst.io

Install from PyPI:
Expand Down
10 changes: 10 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Command-line interface
======================

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

You can get detailed help for any :command:`sasquatch-backpack` command by running :command:`sasquatch-backpack --help`

.. click:: sasquatchbackpack.cli:main
:prog: sasquatchbackpack
:nested: full
1 change: 1 addition & 0 deletions docs/documenteer.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ disable_primary_sidebars = [
"index",
"changelog",
]
extensions = ['sphinx_click']

[sphinx.intersphinx.projects]
python = "https://docs.python.org/3/"
9 changes: 8 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@
sasquatch-backpack
##################

Collects data and feeds sasquatch.
Sasquatch-backpack is a collection of APIs that feed into sasquatch.

Install sasquatch-backpack from PyPI:

.. code-block:: bash
pip install sasquatch-backpack
The current APIs that run off of sasquatch-backpack are:

- USGS Earthquake data (`libcomcat <https://code.usgs.gov/ghsc/esi/libcomcat-python>`__)

Sasquatch-backpack also features CLI entrypoints for easy access to integrated APIs. See the CLI Page above for details.

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

.. toctree::
Expand All @@ -22,3 +28,4 @@ sasquatch-backpack is developed on GitHub at https://github.com/lsst-sqre/sasqua
API <api>
Change log <changelog>
Contributing <dev/index>
CLI <cli>
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ dev = [
# Documentation
"documenteer[guide]<2",
"scriv",
"sphinx_click",
]

[project.urls]
Expand Down

0 comments on commit 96da1a8

Please sign in to comment.