Revise openturbine documentation #346
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
faisal-bhuiyan
added
documentation
…to change in docs related content
…ext + move compiling chapter to walkthru folder
deslaughter
approved these changes
Feb 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This work introduces significant improvements to the OpenTurbine documentation and transfers the documentation to a sphinx-based one:
Organized into sections: 'Getting Started', 'User Guide', 'Theory Manual', and 'Developer Docs' -- similar to rest of the ExaWind portfolio codes such as amr-wind
Theory guide contains preliminary implementation of several sections from
OpenTurbineTheoryas a proof-of-concept implementationAPI documentation generated with Doxygen and added as part of the Developer Guide
Automatically deployed using a GitHub workflow
Addresses https://github.com/Exawind/openturbine-project/issues/28.