update docs

StingraySoftware · Nov 8, 2024 · 7e51632 · 7e51632
1 parent cfc8296
commit 7e51632
Show file tree

Hide file tree

Showing 5 changed files with 209 additions and 13 deletions.
diff --git a/docs/source/DataLoading.rst b/docs/source/DataLoading.rst
@@ -11,6 +11,8 @@ DataLoading.DataIngestion module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 Module contents
 ---------------
@@ -19,3 +21,5 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
diff --git a/docs/source/Home.rst b/docs/source/Home.rst
@@ -11,6 +11,8 @@ Home.HomeContent module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 Module contents
 ---------------
@@ -19,3 +21,5 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
diff --git a/docs/source/QuickLook.rst b/docs/source/QuickLook.rst
@@ -11,6 +11,8 @@ QuickLook.AverageCrossSpectrum module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.AveragePowerSpectrum module
 -------------------------------------
@@ -19,6 +21,8 @@ QuickLook.AveragePowerSpectrum module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.Bispectrum module
 ---------------------------
@@ -27,6 +31,8 @@ QuickLook.Bispectrum module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.CrossSpectrum module
 ------------------------------
@@ -35,6 +41,8 @@ QuickLook.CrossSpectrum module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.LightCurve module
 ---------------------------
@@ -43,6 +51,8 @@ QuickLook.LightCurve module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.PowerColors module
 ----------------------------
@@ -51,6 +61,8 @@ QuickLook.PowerColors module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 QuickLook.PowerSpectrum module
 ------------------------------
@@ -59,6 +71,8 @@ QuickLook.PowerSpectrum module
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
 
 Module contents
 ---------------
@@ -67,3 +81,5 @@ Module contents
    :members:
    :undoc-members:
    :show-inheritance:
+   :special-members: __init__, __call__  # Include special methods like __init__
+   :inherited-members:  # Shows inherited methods in classes
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,13 +19,20 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',       # For Google-style docstrings
-    'sphinx.ext.viewcode',       # Adds links to source code
-    'sphinx.ext.autosummary',    # Generate summaries automatically
+    'sphinx.ext.autodoc',           # Main extension for auto-documentation
+    'sphinx.ext.napoleon',          # Supports Google/NumPy style docstrings
+    'sphinx.ext.autosummary',       # Generates summary tables for modules/classes
+    'sphinx.ext.viewcode',          # Adds links to highlighted source code
+    'sphinx.ext.intersphinx',       # Links to documentation of external libraries
 ]
+
 autosummary_generate = True      # Enables automatic summary generation
 
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
+}
 
 templates_path = ['_templates']
 exclude_patterns = []