Merge branch 'develop' into jml_di

spacetelescope · Dec 11, 2024 · a5872f3 · a5872f3
2 parents 02f2304 + 7051516
commit a5872f3
Show file tree

Hide file tree

Showing 19 changed files with 4,647 additions and 4,818 deletions.
diff --git a/docs/source/TLDR.rst b/docs/source/TLDR.rst
@@ -5,4 +5,3 @@ TL;DR Setup Guide
     $ git clone https://github.com/kammerje/spaceKLIP.git
     $ pip install -r requirements.txt
     $ pip install -e .
-    $ python make_psfmasks.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -63,7 +63,8 @@
 templates_path = []#['./_templates']
 
 # mock imports for autodoc
-autodoc_mock_imports = ["webbpsf"]
+autodoc_mock_imports = ["webbpsf", "webbpsf_ext"]
+
 
 # nbsphinx settings
 nbsphinx_allow_errors = True
@@ -85,6 +86,7 @@
 
 # The master toctree document.
 master_doc = 'index'
+automodapi_inherit_docstrings = True
 
 # General information about the project.
 project = u'spaceKLIP'
@@ -282,7 +284,7 @@ def setup(app):
 
 # If true, links to the reST sources are added to the pages.
 #
-# html_show_sourcelink = True
+html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 #

diff --git a/docs/source/gen_index.rst b/docs/source/gen_index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -92,7 +92,7 @@ Compatible Simulated Data: `Here <https://stsci.box.com/s/cktghuyrwrallb401rw5y5
    :hidden:
 
    spaceKLIP
-   gen_index
+
 
 
 

diff --git a/docs/source/spaceKLIP.rst b/docs/source/spaceKLIP.rst
@@ -49,14 +49,21 @@ spaceKLIP.database module
    :undoc-members:
    :show-inheritance:
 
-spaceKLIP.fnoise_clean module
------------------------------
+spaceKLIP.expjumpramp module
+----------------------------
 
-.. automodule:: spaceKLIP.fnoise_clean
+.. automodule:: spaceKLIP.expjumpramp
    :members:
    :undoc-members:
    :show-inheritance:
 
+spaceKLIP.fnoise\_clean module
+------------------------------
+
+.. automodule:: spaceKLIP.fnoise_clean
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 spaceKLIP.imagetools module
 ---------------------------
@@ -66,6 +73,14 @@ spaceKLIP.imagetools module
    :undoc-members:
    :show-inheritance:
 
+spaceKLIP.logging\_tools module
+-------------------------------
+
+.. automodule:: spaceKLIP.logging_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 spaceKLIP.mast module
 ---------------------
 
@@ -114,10 +129,10 @@ spaceKLIP.utils module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
+spaceKLIP.wcs\_utils module
+---------------------------
 
-.. automodule:: spaceKLIP
+.. automodule:: spaceKLIP.wcs_utils
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/stage1.rst b/docs/source/stage1.rst
@@ -1,4 +1,5 @@
 .. _stage1:
+
 Stage 1
 =======
Original file line number	Diff line number	Diff line change
Expand Up		@@ -92,7 +92,7 @@ Compatible Simulated Data: `Here <https://stsci.box.com/s/cktghuyrwrallb401rw5y5
		:hidden:

		spaceKLIP
		gen_index




Expand Down
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     .. _stage1:
     Stage 1
     =======
@@ Expand Down @@