NREL / ROSCO

A Reference Open Source Controller for Wind Turbines
https://rosco.readthedocs.io/en/latest/
Apache License 2.0
116 stars 93 forks source link

Docs #368

Closed dzalkind closed 1 month ago

dzalkind commented 4 months ago

Description and Purpose

Copy of @abhineet-gupta 's notes from #371: This pull request implements the use of automatic documentation for documenting examples. This is demonstrated with example-1.

Examples need to be modified so that the code is contained within a function. Otherwise, examples get executed while building the documentation. Also, the docstrings of other examples need to be modified to be in suitabl rst format like example-1

Type of change

What types of change is it? Select the appropriate type(s) that describe this PR

TODO Items General:

TODO Items API Change:

Github issues addressed, if one exists

Examples/Testing, if applicable

abhineet-gupta commented 4 months ago

Fixed the issue with readthedocs and it builds now.