Fixing documentation build (#30)

* Fixing documentation build

* remove main from deploy-pages.yaml; remote unused _templates.

* Typo fixes in docs.

---------

Co-authored-by: misi9170 <[email protected]>

.github/workflows/deploy-pages.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
     - develop
-    - main
     paths:
     - docs/**
 

docs/_config.yml

@@ -4,7 +4,7 @@
 title: Wind Hybrid Open Controller
 author: National Renewable Energy Laboratory
 # logo: herc.png
-copyright: '2023'
+copyright: '2024'
 only_build_toc_files: false
 
 # Force re-execution of notebooks on each build.
@@ -36,37 +36,3 @@ html:
   google_analytics_id: G-BJZY823DHG
 
 
-# Sphinx for API doc generation
-sphinx:
-  extra_extensions:
-  - 'sphinx.ext.autodoc'
-  - 'sphinx.ext.autosummary'
-  - 'sphinx.ext.viewcode'
-  - 'sphinx_autodoc_typehints'
-  - 'sphinxcontrib.autoyaml'
-  - 'sphinx.ext.napoleon'       # Formats google and numpy docstring styles
-  - 'sphinxcontrib.mermaid'
-  config:
-    html_theme: sphinx_book_theme
-    templates_path:
-    - '_templates'
-    language: 'python'
-    autoyaml_level: 3
-    autosummary_generate: true
-
-    # Autodoc config reference
-    # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
-    autodoc_default_options:
-      members: true
-      member-order: bysource
-      undoc-members: true
-      private-members: true
-      # special-members: true
-      # inherited-members
-      # show-inheritance
-      # ignore-module-all
-      # imported-members: true
-      # exclude-members
-      # class-doc-from
-      # no-value
-    autodoc_typehints: both

docs/examples.md

@@ -1,6 +1,6 @@
 # Examples
 
-The `examples` subdirectoy contains a series of examples that can be run to test the functionality
+The `examples` subdirectory contains a series of examples that can be run to test the functionality
 of certain controllers and interfaces.
 
 ### lookup-based_wake_steering_florisstandin
@@ -11,9 +11,9 @@ examples/lookup-based_wake_steering_florisstandin and then run the following.
 python construct_yaw_offsets.py
 ```
 
-Not that, currently, contruct_yaw_offsets.py requires FLORIS version 3, whereas the rest of the 
+Not that, currently, construct_yaw_offsets.py requires FLORIS version 3, whereas the rest of the 
 example requires FLORIS version 4. As a result, we provide the generated offsets in
-yaw_offesets.pkl. To avoid regenerating yaw_offsets.pkl (and therefore avoid the current need for 
+yaw_offsets.pkl. To avoid regenerating yaw_offsets.pkl (and therefore avoid the current need for 
 floris v3), set `optimize_yaw_offsets = False` at the beginning of construct_yaw_offsets.py before
 running.
 

docs/install_instructions.md

@@ -3,9 +3,9 @@
 WHOC is _not_ designed to be used as a stand-alone package. Most likely, 
 you'll want to add WHOC to an existing conda environment that contains your
 simulation testbed, such as [Hercules](https://github.com/NREL/hercules). 
-For example, see the [Hercules installation instuctions](\
-https://nrel.github.io/hercules/install_instructions.html) for how to set up
-an appropriate conda environment.
+For example, see the 
+[Hercules installation instructions](https://nrel.github.io/hercules/install_instructions.html)
+for how to set up an appropriate conda environment.
 
 ## General users
 

docs/interfaces.md

@@ -5,14 +5,14 @@ WHOC with various simulation platforms and other repositories. Each controller
 run will require an `interface`, which is an instantiated object of a class
 in this library. All interface classes should inherit from `InterfaceBase`, 
 which can be found n interface_base.py, and should implement three methods:
-- `get_measurements()`: Recieve measurements from simulation assets and 
+- `get_measurements()`: Receive measurements from simulation assets and 
 organize into a dictionary that the calling controller can utilize. Optionally,
 receives a large dictionary (for example, the Hercules `main_dict`), from which
 useable measurements can be extracted/repackaged for easy use in the controller.
 - `check_controls()`: Check that the keys in `controls_dict` are viable for 
 the receiving plant.
 - `send_controls()`: Send controls to the simulation assets. Controls are 
-created as specific keyword arguements, which match those controls generated
+created as specific keyword arguments, which match those controls generated
 by the calling controller. Optionally, receives a large dictionary 
 (for example, the Hercules `main_dict`), which can be written to and returned
 with controls as needed.

docs/intro.md

@@ -23,7 +23,7 @@ found in controllers.md.
 The `interface` object handles communications with the plant simulator, 
 allowing WHOC to be used with various simulation platforms (e.g. Hercules, 
 FAST.Farm) while keeping the controllers agnostic to the simulation platform
-and the boilderplate code needed to handle different platforms. `interface` 
+and the boilerplate code needed to handle different platforms. `interface` 
 objects should inherit from `InterfaceBase`. More information can be found in 
 interfaces.md.
 

setup.py

@@ -57,11 +57,11 @@
 # What packages are optional?
 EXTRAS = {
     "docs": {
-        "jupyter-book<=0.13.3",
+        "jupyter-book",
         "sphinx-book-theme",
-        "sphinx-autodoc-typehints",
-        "sphinxcontrib-autoyaml",
-        "sphinxcontrib.mermaid",
+        # "sphinx-autodoc-typehints",
+        # "sphinxcontrib-autoyaml",
+        # "sphinxcontrib.mermaid",
     },
     "develop": {
         "pytest",