diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b0a73ba2..631c373e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,7 +19,7 @@ sphinx: # Then, install special pinning for RTD. python: install: - - requirements: requirements.txt + - requirements: docs/requirements.txt - method: pip path: . diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..f32524b0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinx +pydata-sphinx-theme +sphinx-design +nbsphinx +myst-parser \ No newline at end of file diff --git a/docs/source/project_details/tech_details.rst b/docs/source/project_details/tech_details.rst index ff4fe183..86ac168b 100644 --- a/docs/source/project_details/tech_details.rst +++ b/docs/source/project_details/tech_details.rst @@ -11,4 +11,6 @@ details specifically on the automatic loss factor analysis of the unlabeled PV e loss factors using Shapley values. The estimation of the location and orientation algorithm (also a method of the DataHandler class) is described in this -`IEEE 2021 PVSC paper `_. \ No newline at end of file +`IEEE 2021 PVSC paper `_. + +Most of the algorithms make use of a "signal decomposition" framework that was developed in parallel with this software. You can find a monograph explaining this concept `here `__ (mirrored `here `__) and a "no math, no code" tutorial on signal decomposition `here `__. diff --git a/requirements.txt b/requirements.txt index 0b4d1306..a9dd4ccc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,10 +21,4 @@ dask distributed dask-cloudprovider[all] graphviz -bokeh -# Packages below this line are for the documentation (optional) -sphinx -pydata-sphinx-theme -sphinx-design -nbsphinx -myst-parser +bokeh \ No newline at end of file