DOCS: Added SpectralIndices, SpectralIndex (#9)

awesome-spectral-indices · Jan 18, 2022 · a890b17 · a890b17
1 parent 26751c1
commit a890b17
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 2 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -20,17 +20,17 @@ and can be called from it (e.g., :code:`spyndex.computeIndex()`):
 spyndex.axioms
 ---------------
 
-Axioms module of spyndex. Automatically loaded with :code:`import spyndex`. Spectral Indices
+Axioms module of spyndex. Automatically loaded with :code:`import spyndex`. Spectral Indices, Constants and Bands
 can be accessed from the module (e.g. :code:`spyndex.indices.NDVI`):
 
 .. currentmodule:: spyndex.axioms
 
 .. autosummary::
-   :toctree: stubs
 
    SpectralIndices
    SpectralIndex
 
+
 spyndex.datasets
 ----------------
 

diff --git a/docs/stubs/spyndex.axioms.SpectralIndex.rst b/docs/stubs/spyndex.axioms.SpectralIndex.rst
@@ -0,0 +1,31 @@
+spyndex.axioms.SpectralIndex
+============================
+
+.. currentmodule:: spyndex.axioms
+
+.. autoclass:: SpectralIndex
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~SpectralIndex.short_name
+      ~SpectralIndex.long_name
+      ~SpectralIndex.bands
+      ~SpectralIndex.type
+      ~SpectralIndex.reference
+      ~SpectralIndex.formula
+      ~SpectralIndex.date_of_addition
+      ~SpectralIndex.contributor
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~SpectralIndex.compute
+
+   .. automethod:: compute
+
+
+
+
diff --git a/docs/stubs/spyndex.axioms.SpectralIndices.rst b/docs/stubs/spyndex.axioms.SpectralIndices.rst
@@ -0,0 +1,12 @@
+spyndex.axioms.SpectralIndices
+==============================
+
+.. currentmodule:: spyndex.axioms
+
+.. autoclass:: SpectralIndices
+
+
+
+
+
+
diff --git a/docs/stubs/spyndex.plot.heatmap.rst b/docs/stubs/spyndex.plot.heatmap.rst
@@ -0,0 +1,6 @@
+spyndex.plot.heatmap
+====================
+
+.. currentmodule:: spyndex.plot
+
+.. autofunction:: heatmap