first draft of readthedocs

FoleyLab · Mar 24, 2022 · f4aa6a3 · f4aa6a3
1 parent 740d6bb
commit f4aa6a3
Show file tree

Hide file tree

Showing 10 changed files with 302 additions and 84 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,7 +1,17 @@
 API Documentation
 =================
 
+Data for distances
+
 .. autosummary::
-   :toctree: autosummary
+    :toctree: autosummary
+
+    wpspecdev.spectrum_driver
+
+    wpspecdev.TmmDriver
+
+    wpspecdev.MieDriver
+
+    wpspecdev.therml
 
-   wpspecdev.canvas
+    wpspecdev.materials
diff --git a/docs/autosummary/wpspecdev.MieDriver.rst b/docs/autosummary/wpspecdev.MieDriver.rst
@@ -0,0 +1,47 @@
+wpspecdev.MieDriver
+===================
+
+.. currentmodule:: wpspecdev
+
+.. autoclass:: MieDriver
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~MieDriver.__init__
+      ~MieDriver.compute_hamiltonian
+      ~MieDriver.compute_spectrum
+      ~MieDriver.material_Ag
+      ~MieDriver.material_Air
+      ~MieDriver.material_Al
+      ~MieDriver.material_Al2O3
+      ~MieDriver.material_AlN
+      ~MieDriver.material_Au
+      ~MieDriver.material_H2O
+      ~MieDriver.material_HfO2
+      ~MieDriver.material_Pb
+      ~MieDriver.material_Pt
+      ~MieDriver.material_Re
+      ~MieDriver.material_Rh
+      ~MieDriver.material_Ru
+      ~MieDriver.material_Si
+      ~MieDriver.material_SiO2
+      ~MieDriver.material_Ta2O5
+      ~MieDriver.material_TiN
+      ~MieDriver.material_TiO2
+      ~MieDriver.material_W
+      ~MieDriver.material_polystyrene
+      ~MieDriver.material_static_refractive_index
+      ~MieDriver.parse_input
+      ~MieDriver.set_refractive_indicex_array
+
+
+
+
+
+
diff --git a/docs/autosummary/wpspecdev.TmmDriver.rst b/docs/autosummary/wpspecdev.TmmDriver.rst
@@ -0,0 +1,53 @@
+wpspecdev.TmmDriver
+===================
+
+.. currentmodule:: wpspecdev
+
+.. autoclass:: TmmDriver
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~TmmDriver.__init__
+      ~TmmDriver.compute_cooling_gradient
+      ~TmmDriver.compute_explicit_angle_spectrum
+      ~TmmDriver.compute_explicit_angle_spectrum_gradient
+      ~TmmDriver.compute_spectrum
+      ~TmmDriver.compute_spectrum_gradient
+      ~TmmDriver.compute_stpv
+      ~TmmDriver.compute_stpv_gradient
+      ~TmmDriver.material_Ag
+      ~TmmDriver.material_Air
+      ~TmmDriver.material_Al
+      ~TmmDriver.material_Al2O3
+      ~TmmDriver.material_AlN
+      ~TmmDriver.material_Au
+      ~TmmDriver.material_H2O
+      ~TmmDriver.material_HfO2
+      ~TmmDriver.material_Pb
+      ~TmmDriver.material_Pt
+      ~TmmDriver.material_Re
+      ~TmmDriver.material_Rh
+      ~TmmDriver.material_Ru
+      ~TmmDriver.material_Si
+      ~TmmDriver.material_SiO2
+      ~TmmDriver.material_Ta2O5
+      ~TmmDriver.material_TiN
+      ~TmmDriver.material_TiO2
+      ~TmmDriver.material_W
+      ~TmmDriver.material_polystyrene
+      ~TmmDriver.material_static_refractive_index
+      ~TmmDriver.parse_input
+      ~TmmDriver.render_color
+      ~TmmDriver.set_refractive_index_array
+
+
+
+
+
+
diff --git a/docs/autosummary/wpspecdev.materials.rst b/docs/autosummary/wpspecdev.materials.rst
@@ -0,0 +1,29 @@
+wpspecdev.materials
+===================
+
+.. automodule:: wpspecdev.materials
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Materials
+
+
+
+
+
+
+
+
+
diff --git a/docs/autosummary/wpspecdev.spectrum_driver.rst b/docs/autosummary/wpspecdev.spectrum_driver.rst
@@ -0,0 +1,29 @@
+wpspecdev.spectrum\_driver
+==========================
+
+.. automodule:: wpspecdev.spectrum_driver
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      SpectrumDriver
+
+
+
+
+
+
+
+
+
diff --git a/docs/autosummary/wpspecdev.therml.rst b/docs/autosummary/wpspecdev.therml.rst
@@ -0,0 +1,29 @@
+wpspecdev.therml
+================
+
+.. automodule:: wpspecdev.therml
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Therml
+
+
+
+
+
+
+
+
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ Welcome to wpspecdev's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   quickstart
    getting_started
    api
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -0,0 +1,14 @@
+Quickstart Guide
+=============================
+
+To do a developmental install, type
+
+`pip install -e .`
+
+Dependencies
+**************
+You need to install `numpy`
+
+Subheader
+-------------------
+Sample subheader