Merge pull request #13 from tylerapritchard/configandcloud

Added DOWNLOAD_CLOUD functionality, reworked the parameter file, smaller fixes
lightkurve · Jul 11, 2024 · 983a20a · 983a20a
2 parents 3e2006d + 2b78947
commit 983a20a
Show file tree

Hide file tree

Showing 11 changed files with 829 additions and 128 deletions.
diff --git a/README.rst b/README.rst
@@ -79,9 +79,10 @@ Usage
 Contributing
 ============
 
-We welcome community contributions!
+**lksearch**  is an open-source, community driven package. 
+We welcome users to contribute and develop new features for lksearch.  
 
-Guidelines TBD
+For further information, please see the `Lightkurve Community guidelines <https://docs.lightkurve.org/development/contributing.html>`_.
 
 .. <!-- Contributing content end -->
 
@@ -92,7 +93,11 @@ Citing
 
 If you find **lksearch** useful in your research, please cite it and give us a GitHub star!
 
-Citation Instructions TBD
+If you use Lightkurve for work or research presented in a publication, we request the following acknowledgment or citation:
+
+`This research made use of Lightkurve, a Python package for Kepler and TESS data analysis (Lightkurve Collaboration, 2018).`
+
+See full citation instuctions, including dependencies, in the `Lightkurve documentation <https://docs.lightkurve.org/about/citing.html>`_. 
 
 .. <!-- Citing content end -->
 

diff --git a/docs/apidoc.rst b/docs/apidoc.rst
@@ -13,4 +13,7 @@ API documentation
    :members:
 
 .. autoclass:: lksearch.TESSSearch
+   :members:
+
+.. automodule:: lksearch.config
    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,7 @@
    sphinx-quickstart on Mon Apr 22 14:10:27 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
+
 ########
 lksearch
 ########