Readthedocs pr (#61)

* New Sphinx Environment * User Guide - Package Overview * Modules API * API reference * Monte Carlo User Guide * include external link aliases --------- Co-authored-by: tobin-ford <[email protected]> Co-authored-by: martin-springer <[email protected]>
NREL · Feb 9, 2024 · 188a6ae · 188a6ae
1 parent ef19e6c
commit 188a6ae
Show file tree

Hide file tree

Showing 123 changed files with 2,312 additions and 730 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,7 +17,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/sphinx/source/conf.py
+   configuration: docs/source/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:

diff --git a/docs/sphinx/Makefile → docs/Makefile b/docs/sphinx/Makefile → docs/Makefile
diff --git a/docs/sphinx/make.bat → docs/make.bat b/docs/sphinx/make.bat → docs/make.bat
@@ -10,8 +10,6 @@ if "%SPHINXBUILD%" == "" (
 set SOURCEDIR=source
 set BUILDDIR=build
 
-if "%1" == "" goto help
-
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -21,10 +19,12 @@ if errorlevel 9009 (
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

diff --git a/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_cp.rst b/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_cp.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.calculate\_jsc\_from\_tau\_cp
+==============================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: calculate_jsc_from_tau_cp
diff --git a/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_iqe.rst b/docs/source/_autosummary/pvdeg.collection.calculate_jsc_from_tau_iqe.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.calculate\_jsc\_from\_tau\_iqe
+===============================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: calculate_jsc_from_tau_iqe
diff --git a/docs/source/_autosummary/pvdeg.collection.collection_probability.rst b/docs/source/_autosummary/pvdeg.collection.collection_probability.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.collection\_probability
+========================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: collection_probability
diff --git a/docs/source/_autosummary/pvdeg.collection.generation_current.rst b/docs/source/_autosummary/pvdeg.collection.generation_current.rst
@@ -0,0 +1,6 @@
+pvdeg.collection.generation\_current
+====================================
+
+.. currentmodule:: pvdeg.collection
+
+.. autofunction:: generation_current
diff --git a/docs/source/_autosummary/pvdeg.collection.rst b/docs/source/_autosummary/pvdeg.collection.rst
@@ -0,0 +1,77 @@
+.. Please when editing this file make sure to keep it matching the
+   docs in ../configuration.rst:reference_to_examples
+
+pvdeg.collection
+================
+
+.. automodule:: pvdeg.collection
+
+   .. this is crazy  
+
+   
+   
+
+   Function Overview
+   -----------------
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+
+      pvdeg.collection.calculate_jsc_from_tau_cp
+      pvdeg.collection.calculate_jsc_from_tau_iqe
+      pvdeg.collection.collection_probability
+      pvdeg.collection.generation_current
+
+
+
+
+   .. this is crazy  
+
+   
+   
+
+.. 
+   Functions
+   ---------
+
+
+
+   .. autofunction:: calculate_jsc_from_tau_cp
+
+   .. _sphx_glr_backref_pvdeg.collection.calculate_jsc_from_tau_cp:
+
+   .. minigallery:: pvdeg.collection.calculate_jsc_from_tau_cp
+       :add-heading:
+
+   .. autofunction:: calculate_jsc_from_tau_iqe
+
+   .. _sphx_glr_backref_pvdeg.collection.calculate_jsc_from_tau_iqe:
+
+   .. minigallery:: pvdeg.collection.calculate_jsc_from_tau_iqe
+       :add-heading:
+
+   .. autofunction:: collection_probability
+
+   .. _sphx_glr_backref_pvdeg.collection.collection_probability:
+
+   .. minigallery:: pvdeg.collection.collection_probability
+       :add-heading:
+
+   .. autofunction:: generation_current
+
+   .. _sphx_glr_backref_pvdeg.collection.generation_current:
+
+   .. minigallery:: pvdeg.collection.generation_current
+       :add-heading:
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/pvdeg.degradation.IwaArrhenius.rst b/docs/source/_autosummary/pvdeg.degradation.IwaArrhenius.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.IwaArrhenius
+==============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: IwaArrhenius
diff --git a/docs/source/_autosummary/pvdeg.degradation.IwaVantHoff.rst b/docs/source/_autosummary/pvdeg.degradation.IwaVantHoff.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.IwaVantHoff
+=============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: IwaVantHoff
diff --git a/docs/source/_autosummary/pvdeg.degradation.arrhenius_deg.rst b/docs/source/_autosummary/pvdeg.degradation.arrhenius_deg.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.arrhenius\_deg
+================================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: arrhenius_deg
diff --git a/docs/source/_autosummary/pvdeg.degradation.degradation.rst b/docs/source/_autosummary/pvdeg.degradation.degradation.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.degradation
+=============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: degradation
diff --git a/docs/source/_autosummary/pvdeg.degradation.rst b/docs/source/_autosummary/pvdeg.degradation.rst
@@ -0,0 +1,85 @@
+.. Please when editing this file make sure to keep it matching the
+   docs in ../configuration.rst:reference_to_examples
+
+pvdeg.degradation
+=================
+
+.. automodule:: pvdeg.degradation
+
+   .. this is crazy  
+
+   
+   
+
+   Function Overview
+   -----------------
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+
+      pvdeg.degradation.IwaArrhenius
+      pvdeg.degradation.IwaVantHoff
+      pvdeg.degradation.arrhenius_deg
+      pvdeg.degradation.degradation
+      pvdeg.degradation.vantHoff_deg
+
+
+
+
+   .. this is crazy  
+
+   
+   
+
+.. 
+   Functions
+   ---------
+
+
+
+   .. autofunction:: IwaArrhenius
+
+   .. _sphx_glr_backref_pvdeg.degradation.IwaArrhenius:
+
+   .. minigallery:: pvdeg.degradation.IwaArrhenius
+       :add-heading:
+
+   .. autofunction:: IwaVantHoff
+
+   .. _sphx_glr_backref_pvdeg.degradation.IwaVantHoff:
+
+   .. minigallery:: pvdeg.degradation.IwaVantHoff
+       :add-heading:
+
+   .. autofunction:: arrhenius_deg
+
+   .. _sphx_glr_backref_pvdeg.degradation.arrhenius_deg:
+
+   .. minigallery:: pvdeg.degradation.arrhenius_deg
+       :add-heading:
+
+   .. autofunction:: degradation
+
+   .. _sphx_glr_backref_pvdeg.degradation.degradation:
+
+   .. minigallery:: pvdeg.degradation.degradation
+       :add-heading:
+
+   .. autofunction:: vantHoff_deg
+
+   .. _sphx_glr_backref_pvdeg.degradation.vantHoff_deg:
+
+   .. minigallery:: pvdeg.degradation.vantHoff_deg
+       :add-heading:
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/pvdeg.degradation.vantHoff_deg.rst b/docs/source/_autosummary/pvdeg.degradation.vantHoff_deg.rst
@@ -0,0 +1,6 @@
+pvdeg.degradation.vantHoff\_deg
+===============================
+
+.. currentmodule:: pvdeg.degradation
+
+.. autofunction:: vantHoff_deg
diff --git a/docs/source/_autosummary/pvdeg.design.edge_seal_ingress_rate.rst b/docs/source/_autosummary/pvdeg.design.edge_seal_ingress_rate.rst
@@ -0,0 +1,6 @@
+pvdeg.design.edge\_seal\_ingress\_rate
+======================================
+
+.. currentmodule:: pvdeg.design
+
+.. autofunction:: edge_seal_ingress_rate
diff --git a/docs/source/_autosummary/pvdeg.design.edge_seal_width.rst b/docs/source/_autosummary/pvdeg.design.edge_seal_width.rst
@@ -0,0 +1,6 @@
+pvdeg.design.edge\_seal\_width
+==============================
+
+.. currentmodule:: pvdeg.design
+
+.. autofunction:: edge_seal_width
diff --git a/docs/source/_autosummary/pvdeg.design.rst b/docs/source/_autosummary/pvdeg.design.rst
@@ -0,0 +1,61 @@
+.. Please when editing this file make sure to keep it matching the
+   docs in ../configuration.rst:reference_to_examples
+
+pvdeg.design
+============
+
+.. automodule:: pvdeg.design
+
+   .. this is crazy  
+
+   
+   
+
+   Function Overview
+   -----------------
+
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+
+      pvdeg.design.edge_seal_ingress_rate
+      pvdeg.design.edge_seal_width
+
+
+
+
+   .. this is crazy  
+
+   
+   
+
+.. 
+   Functions
+   ---------
+
+
+
+   .. autofunction:: edge_seal_ingress_rate
+
+   .. _sphx_glr_backref_pvdeg.design.edge_seal_ingress_rate:
+
+   .. minigallery:: pvdeg.design.edge_seal_ingress_rate
+       :add-heading:
+
+   .. autofunction:: edge_seal_width
+
+   .. _sphx_glr_backref_pvdeg.design.edge_seal_width:
+
+   .. minigallery:: pvdeg.design.edge_seal_width
+       :add-heading:
+
+
+
+
+
+
+
+
+
+