added documentation

lightkurve · Jul 30, 2024 · 73b2a1e · 73b2a1e
1 parent 979fe41
commit 73b2a1e
Show file tree

Hide file tree

Showing 11 changed files with 1,580 additions and 256 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install poetry
-          poetry install --with dev
+          poetry install --with dev,cloud
       - name: Sphinx build
         run: |
           poetry run sphinx-build docs _build

diff --git a/docs/apidoc.rst b/docs/apidoc.rst
@@ -15,5 +15,8 @@ API
 .. autoclass:: lksearch.TESSSearch
    :members:
 
+.. automodule:: lksearch.catalog
+   :members:
+
 .. automodule:: lksearch.config
    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ lksearch
    :hidden:
 
    Quickstart
-   tutorials/Example_searches
+   tutorials/index
    apidoc
    GetInvolved
    HowtoCite