Testing for readthedocs build of v2.9.0 documentation

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.10"
     # nodejs: "18"
     # rust: "1.64"
     # golang: "1.19"

docs/conf.py

@@ -52,6 +52,7 @@ def __getattr__(cls, name):
     "sphinx.ext.intersphinx",
     "sphinx.ext.graphviz",
     "sphinx.ext.autosectionlabel",
+    "sphinx_rtd_theme",
     # "sphinxcontrib.bibtex",
 ]
 
@@ -84,7 +85,7 @@ def __getattr__(cls, name):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "furo"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -3,6 +3,38 @@ ROSCO Documentation
 :Version: |release|
 :Date: |today|
 
+NREL's "Reference Open Source Controller" (ROSCO) is a reference controller framework that facilitates design and implementation of wind turbine and wind farm controllers for fixed and floating offshore wind turbines.
+
+ROSCO frameworks includes a large set of available controllers and advanced functionalities that can be combined in a modular fashion based on the intended application and can be easily adapted to a wide variety wind turbines.
+For example, ROSCO can be used to design turbine yaw controller along with an individual blade pitch controller with floating platform feedback for an offshore turbine while simulating a pitch actuator fault and running a user-defined torque controller.
+
+ROSCO provides a single framework for designing controllers for onshore and offshore turbines of varying sizes.
+It can be used to run representative dynamic simulations using OpenFAST.
+This helps researchers perform 'apples-to-apples' comparison of controller capabilities across turbines.
+Control engineers can also design their own controllers and compare them with reference controller design using ROSCO for existing and new turbines.
+ROSCO has been used to provide reference controllers for many recent reference turbines including the `IEA 3.4-MW <https://github.com/IEAWindTask37/IEA-3.4-130-RWT>`_ , `IEA 10-MW <https://github.com/IEAWindTask37/IEA-10.0-198-RWT>`_ , `IEA 15-MW <https://github.com/IEAWindTask37/IEA-15-240-RWT>`_ and the upcoming `IEA 22-MW <https://github.com/IEAWindTask37/IEA-22-280-RWT>`_ turbines.
+
+The ROSCO framework also includes a python based toolbox that primarily enables tuning the controllers.
+The tuning process is extemely simple where only a tuning parameters need to be provided.
+It is not necessary to run aeroelastic simulations or provide linearized state-space models to tune the controller to tune the controllers.
+The toolbox has other capabilities like simple 1-DOF turbine simulations for quick controller capability verifications, linear model analysis, and parsing of input and output files.
+
+ROSCO can be found in this `github repository <https://github.com/NREL/ROSCO>`_.
+
+**Documentation Directory**
+
+.. toctree::
+   :maxdepth: 3
+   :numbered:
+
+   source/standard_use.rst
+   source/install.rst
+   source/rosco_toolbox.rst
+   source/rosco.rst
+   source/api_change.rst
+   source/toolbox_input.rst
+   source/ROSCO_instructions_for_Bladed.rst
+
 NREL's Reference OpenSource Controller (ROSCO) tool-set for wind turbine applications designed to ease controller implementation for the wind turbine researcher. The purpose of these documents is to provide information for the use of the tool-set. 
 
 :numref:`fig-RT` shows the general workflow for the ROSCO tool-chain. with OpenFAST
@@ -67,15 +99,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-
-.. toctree::
-   :maxdepth: 3
-   :numbered:
-
-   source/install.rst
-   source/standard_use.rst
-   source/rosco_toolbox.rst
-   source/rosco.rst
-   source/api_change.rst
-   source/toolbox_input.rst
-   source/ROSCO_instructions_for_Bladed.rst

docs/requirements.txt

@@ -1,4 +1,3 @@
 # File: docs/requirements.txt
 
 sphinx>4.0.0
-furo